com.tapkey.mobile.model

Class TkErrorDescriptor

java.lang.Object

com.tapkey.mobile.model.TkErrorDescriptor

public class TkErrorDescriptor
extends Object

Contains information about an error that occurred in a component inside the SDK.

Constructor Summary

Constructors

Constructor and Description
TkErrorDescriptor(String errorCode, String errorMessage, Object errorDetails) Creates an error descriptor.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Returns the error code.
Object	getErrorDetails() Returns the error details.
String	getErrorMessage() Returns the error message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TkErrorDescriptor

public TkErrorDescriptor(String errorCode,
                         String errorMessage,
                         Object errorDetails)

Creates an error descriptor.

Parameters:

errorCode - the error code.

errorMessage - the error message.

errorDetails - additional data to describe or document the error.

Method Detail

getErrorCode

public String getErrorCode()

Returns the error code.

Returns:

the error code.

getErrorMessage

public String getErrorMessage()

Returns the error message. The error message is intended to be used for support and debugging but is not intended to be issued to the user.

Returns:

the error message.

getErrorDetails

public Object getErrorDetails()

Returns the error details. Consult documentation of the throwing method for more information about the type of the error details.

Returns:

the error details.