com.gemalto.idp.mobile.oob.message

Interface OobErrorMessage

All Superinterfaces:

OobMessage, OobMessageMeta, OobOutgoingMessage

public interface OobErrorMessage
extends OobOutgoingMessage, OobMessageMeta

This object allow the client to send some error information to the server.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CODE_CORRUPTED_CONTENT_TYPE Error code: Corrupted content.
static int	ERROR_CODE_CUSTOM_BASE Baseline for the application specific error codes.
static int	ERROR_CODE_UNKNOWN_RECIPIENT Error code: Unknown "TO" (recipient).
static int	ERROR_CODE_UNSUPPORTED_CONTENT_TYPE Error code: Unsupported content type.
static int	ERROR_CODE_UNSUPPORTED_LOCALE Error code: Unsupported locale.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Get the error code.
String	getErrorDescription() Get the error description.
String	getErrorStackTrace() Get the error stack trace.
String	getExternalRef() Get the external reference.
Map<String,String>	getMeta() Get the meta data

Methods inherited from interface com.gemalto.idp.mobile.oob.message.OobOutgoingMessage

getMessageType, setMessageId

Methods inherited from interface com.gemalto.idp.mobile.oob.message.OobMessage

getMessageId, getMessageMIMEType, getProviderId, wipe

Field Detail

ERROR_CODE_UNSUPPORTED_LOCALE

static final int ERROR_CODE_UNSUPPORTED_LOCALE

Error code: Unsupported locale.

See Also:

Constant Field Values

ERROR_CODE_UNSUPPORTED_CONTENT_TYPE

static final int ERROR_CODE_UNSUPPORTED_CONTENT_TYPE

Error code: Unsupported content type.

See Also:

Constant Field Values

ERROR_CODE_CORRUPTED_CONTENT_TYPE

static final int ERROR_CODE_CORRUPTED_CONTENT_TYPE

Error code: Corrupted content.

See Also:

Constant Field Values

ERROR_CODE_UNKNOWN_RECIPIENT

static final int ERROR_CODE_UNKNOWN_RECIPIENT

Error code: Unknown "TO" (recipient).

See Also:

Constant Field Values

ERROR_CODE_CUSTOM_BASE

static final int ERROR_CODE_CUSTOM_BASE

Baseline for the application specific error codes. It is recommended to use this constant for definition of specific error codes.

For example the custom error codes could be:
- ERROR_CODE_CUSTOM_BASE + 0
- ERROR_CODE_CUSTOM_BASE + 1
- ERROR_CODE_CUSTOM_BASE + 2
...

See Also:

Constant Field Values

Method Detail

getErrorCode

int getErrorCode()

Get the error code.

Returns:

The error code.

getErrorDescription

String getErrorDescription()

Get the error description.

Returns:

The error description.

getErrorStackTrace

String getErrorStackTrace()

Get the error stack trace.

Returns:

The error stack trace.

getExternalRef

String getExternalRef()

Get the external reference.

Returns:

The external reference.

getMeta

Map<String,String> getMeta()

Get the meta data

Specified by:

getMeta in interface OobMessageMeta

Returns:

The meta data.