com.gemalto.idp.mobile.core

Interface IdpResult

All Known Subinterfaces:

OobFetchMessageResponse, OobMessageResponse, OobNotificationProfilesResponse, OobRegistrationResponse, OobResponse

public interface IdpResult

Idp Mobile result object.

Once created the object is immutable from outside.

For the existing Ezio Mobile API, this is part of the exception - see IdpException.

In OOB API, it is used as a base class for the OOB server responses.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
int	getCode() Retrieves the Idp result code.
int	getDomain() Retrieves the Idp result domain.
java.lang.Exception	getException() Retrieves the exception from lower level which is a cause for the failure result.
java.lang.String	getMessage() Retrieves the message text.
java.lang.Object	getUserInfo(java.lang.String key) Retrieves the additional data from the result object for the specified key.
java.util.Set<java.lang.String>	getUserInfoKeys() Retrieves the complete set of keys of user data carried by this result object.
boolean	isFailed() Utility method for easily checking whether this result means success or failure.
boolean	isSucceeded() Utility method for easily checking whether this result means success or failure.

Method Detail

isSucceeded

boolean isSucceeded()

Utility method for easily checking whether this result means success or failure.

Returns:

If succeeded then true else false.

isFailed

boolean isFailed()

Utility method for easily checking whether this result means success or failure.

Returns:

If failed then true else false.

getCode

int getCode()

Retrieves the Idp result code.

The result code precisely identifies what went wrong.

Returns:

The Idp result code.

getDomain

int getDomain()

Retrieves the Idp result domain.

The result code domain quickly checks which subsystem the result comes from.

Returns:

The Idp result domain.

getMessage

java.lang.String getMessage()

Retrieves the message text.

The message text detailing what went wrong. It is the deeply technical information, not localized.

Returns:

The message text.

getException

java.lang.Exception getException()

Retrieves the exception from lower level which is a cause for the failure result.

This functions is merely for the purpose of debugging (obtaining the stack traces).

Note:

In case of some failures the exception may still be null, please check getCode() functions - when the failure was not caused by any exception.

Returns:

The exception which caused the failure or null.

getUserInfo

java.lang.Object getUserInfo(java.lang.String key)

Retrieves the additional data from the result object for the specified key.

Each result object can carry the unstructured extra information detailing the problem which occurred. These data are simply a key-value pairs. The keys are always strings. Values can be any object. The key set depends on the source of the error.

Parameters:

key - The key from which to retrieve the user specified data. The key values depend on the result code/domain.

Returns:

The user data for the specified key or null if no such key exists. If the key exists then the data is never null .

getUserInfoKeys

java.util.Set<java.lang.String> getUserInfoKeys()

Retrieves the complete set of keys of user data carried by this result object.

It is useful for iterating through all the user data for instance to display it all.

Returns:

The set of keys into the user info hash table. If this object carries no user data then null.