Top Description Fields Methods
javax.xml.registry

public Interface JAXRResponse

Known Direct Subinterfaces
javax.xml.registry.BulkResponse
Known Direct Implementers
javax.xml.registry.JAXRException

A JAXR requests' response.
Author
Farrukh S. Najmi
See Also
JAXRException

Field Summary

Modifier and TypeField and Description
public static final int
STATUS_FAILURE

Status indicating a failure response.

public static final int
STATUS_SUCCESS

Status indicating a successful response.

public static final int
STATUS_UNAVAILABLE

Status indicating that the results are currently unavailable.

public static final int
STATUS_WARNING

Status indicating a successful response that included at least one warning.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the request id
getRequestId
()

Returns the unique id for the request that generated this response.

public int

Returns:

the status which is an integer enumerated value
getStatus
()

Returns the status for this response.

public boolean

Returns:

true if the response is available; false otherwise
isAvailable
()

Returns true if a response is available, false otherwise.

Field Detail

STATUS_FAILUREback to summary
public static final int STATUS_FAILURE

Status indicating a failure response.

STATUS_SUCCESSback to summary
public static final int STATUS_SUCCESS

Status indicating a successful response.

STATUS_UNAVAILABLEback to summary
public static final int STATUS_UNAVAILABLE

Status indicating that the results are currently unavailable.

STATUS_WARNINGback to summary
public static final int STATUS_WARNING

Status indicating a successful response that included at least one warning.

Method Detail

getRequestIdback to summary
public String getRequestId() throws JAXRException

Returns the unique id for the request that generated this response.

Capability Level: 0
Returns:String

the request id

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getStatusback to summary
public int getStatus() throws JAXRException

Returns the status for this response.

Capability Level: 0
Returns:int

the status which is an integer enumerated value

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
JAXRResponse#STATUS_SUCCESS
isAvailableback to summary
public boolean isAvailable() throws JAXRException

Returns true if a response is available, false otherwise. This is a polling method and must not block.

Capability Level: 0
Returns:boolean

true if the response is available; false otherwise

Exceptions
JAXRException:
If the JAXR provider encounters an internal error