com.ibm.itim.remoteservices.provider

Class AsynchronousResponse

java.lang.Object

com.ibm.itim.remoteservices.provider.AsynchronousResponse

All Implemented Interfaces:

java.io.Serializable

public class AsynchronousResponse
extends java.lang.Object
implements java.io.Serializable

Class that represents the response to an asynchronous request made by a ServiceProvider. This class is very similar in nature to the RequestStatus, with the difference being this class holds a request id that corresponds to the initial request.

See Also:

RequestStatus, ServiceProvider, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AsynchronousResponse(java.lang.String requestId, RequestStatus.Status resultCode) Constructs with a request id and a result code.
AsynchronousResponse(java.lang.String requestId, RequestStatus resultStatus) Constructs with a request id and a RequestStatus for the return status.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() Returns the reason message (if any) of the response.
java.lang.String	getRequestId() Returns the request id of the response.
RequestStatus.Status	getResultCode() Returns the result code of the response.
RequestStatus	getResultStatus() Returns the response Request Status, including the result code and message (if any) of the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsynchronousResponse

public AsynchronousResponse(java.lang.String requestId,
                            RequestStatus.Status resultCode)

Constructs with a request id and a result code.

Parameters:

requestId - id of request this response is for

resultCode - request status result code.

See Also:

RequestStatus

AsynchronousResponse

public AsynchronousResponse(java.lang.String requestId,
                            RequestStatus resultStatus)

Constructs with a request id and a RequestStatus for the return status.

Parameters:

requestId - id of request this response is for.

resultStatus - RequestStatus holding the result code and message.

Method Detail

getRequestId

public java.lang.String getRequestId()

Returns the request id of the response.

Returns:

the request id of the response.

getResultCode

public RequestStatus.Status getResultCode()

Returns the result code of the response.

Returns:

result code.

getMessage

public java.lang.String getMessage()

Returns the reason message (if any) of the response.

Returns:

the reason message / null if none.

getResultStatus

public RequestStatus getResultStatus()

Returns the response Request Status, including the result code and message (if any) of the response.

Returns:

RequestStatus of response.