com.six.timapi

Class TimException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.six.timapi.TimException

All Implemented Interfaces:

Serializable

public class TimException
extends Exception

Contains information about a failed request or method call. For synchronous method calls TimException is thrown as exception. For asynchronous method calls TimException is included in the TimEvent. Immutable class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimException(ResultCode resultCode) Create exception.
TimException(ResultCode resultCode, String errorMessage, NativeError nativeError, PpInfo ppInfo, Map<String,String> additionalErrorInfo, PrintData printData, Basket rejectedBasket) Create exception.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalErrorInfo() Additional error information mapping error text to error type.
String	getErrorMessage() Error message in the ECR language.
String	getLocalizedMessage() Localized error message.
String	getMessage() Get error message.
NativeError	getNativeError() Native error if present.
PpInfo	getPpInfo() Payment protocol specific information.
PrintData	getPrintData() The tag can have two different payloads depending on how the receipt creation and printing is handled.
Basket	getRejectedBasket() Rejected basket as modified by host or null if absent.
ResultCode	getResultCode() Contains the result code with the error.
String	toString() String representation for debugging purpose.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimException

public TimException(ResultCode resultCode)

Create exception.

TimException

public TimException(ResultCode resultCode,
                    String errorMessage,
                    NativeError nativeError,
                    PpInfo ppInfo,
                    Map<String,String> additionalErrorInfo,
                    PrintData printData,
                    Basket rejectedBasket)

Create exception.

Method Detail

getLocalizedMessage

public String getLocalizedMessage()

Localized error message.

Overrides:

getLocalizedMessage in class Throwable

getMessage

public String getMessage()

Get error message.

Overrides:

getMessage in class Throwable

getResultCode

public ResultCode getResultCode()

Contains the result code with the error.

getErrorMessage

public String getErrorMessage()

Error message in the ECR language.

getNativeError

public NativeError getNativeError()

Native error if present.

getPpInfo

public PpInfo getPpInfo()

Payment protocol specific information. Mandatory if any information is given by the underlying payment protocol.

getAdditionalErrorInfo

public Map<String,String> getAdditionalErrorInfo()

Additional error information mapping error text to error type. Mandatory if any additional error information available.

getPrintData

public PrintData getPrintData()

The tag can have two different payloads depending on how the receipt creation and printing is handled. If the terminal creates the receipts itself, PrintData only contains one or multiple tags. If the ECR wishes to create the receipts, the terminal can only send the required that are used in the receipts. This functionality is only available for transaction receipts, not for any admin receipts.

Optional: Mandatory if declined receipts are enabled and any receipt data available.

getRejectedBasket

public Basket getRejectedBasket()

Rejected basket as modified by host or null if absent. Used for Guides.PETROL only.

toString

public String toString()

String representation for debugging purpose.

Overrides:

toString in class Throwable