Package javax.xml.registry
Interface JAXRResponse
- All Known Subinterfaces:
BulkResponse
- All Known Implementing Classes:
DeleteException
,FindException
,InvalidRequestException
,JAXRException
,RegistryException
,SaveException
,UnexpectedObjectException
,UnsupportedCapabilityException
public interface JAXRResponse
A Jakarta XML Registries requests' response.
- Author:
- Farrukh S. Najmi
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Status indicating a failure response.static final int
Status indicating a successful response.static final int
Status indicating that the results are currently unavailable.static final int
Status indicating a successful response that included at least one warning. -
Method Summary
Modifier and TypeMethodDescriptionReturns the unique id for the request that generated this response.int
Returns the status for this response.boolean
Returns true if a response is available, false otherwise.
-
Field Details
-
STATUS_SUCCESS
static final int STATUS_SUCCESSStatus indicating a successful response.- See Also:
-
STATUS_WARNING
static final int STATUS_WARNINGStatus indicating a successful response that included at least one warning.- See Also:
-
STATUS_FAILURE
static final int STATUS_FAILUREStatus indicating a failure response.- See Also:
-
STATUS_UNAVAILABLE
static final int STATUS_UNAVAILABLEStatus indicating that the results are currently unavailable.- See Also:
-
-
Method Details
-
getRequestId
Returns the unique id for the request that generated this response.- Capability Level: 0
- Returns:
- the request id
- Throws:
JAXRException
- If the Jakarta XML Registries provider encounters an internal error
-
getStatus
Returns the status for this response.- Capability Level: 0
- Returns:
- the status which is an integer enumerated value
- Throws:
JAXRException
- If the Jakarta XML Registries provider encounters an internal error- See Also:
-
isAvailable
Returns true if a response is available, false otherwise. This is a polling method and must not block.- Capability Level: 0
- Returns:
true
if the response is available;false
otherwise- Throws:
JAXRException
- If the Jakarta XML Registries provider encounters an internal error
-