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

AsynchronousResponse(java.lang.String requestId, int 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

java.lang.String	getMessage() Returns the message (if any) of the response.
java.lang.String	getRequestId() Returns the request id of the response.
int	getResultCode() Returns the result code of the response.
RequestStatus	getResultStatus() Returns 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,
                            int resultCode)

Constructs with a request id and a result code. See RequestStatus for the appropriate result code values, i.e., SUCCESSFUL and UNSUCCESSFUL.

Parameters:

requestId - id of request this response is for

resultCode - int representation of request result, see RequestStatus for possible values.

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:

int representation of the request id.

getResultCode

public int getResultCode()

Returns the result code of the response.

Returns:

int representation of the result code, see RequestStatus for possible values.

getMessage

public java.lang.String getMessage()

Returns the message (if any) of the response.

Returns:

String representation of the message.

getResultStatus

public RequestStatus getResultStatus()

Returns the result code and message (if any) of the response.

Returns:

RequestStatus holding the result code and message.