-
- All Known Subinterfaces:
- BulkResponse
- All Known Implementing Classes:
- DeleteException, FindException, InvalidRequestException, JAXRException, RegistryException, SaveException, UnexpectedObjectException, UnsupportedCapabilityException
public interface JAXRResponse
A JAXR requests' response.- Author:
- Farrukh S. Najmi
- See Also:
JAXRException
-
-
Field Summary
Fields Modifier and Type Field and Description static int
STATUS_FAILURE
Status indicating a failure response.static int
STATUS_SUCCESS
Status indicating a successful response.static int
STATUS_UNAVAILABLE
Status indicating that the results are currently unavailable.static int
STATUS_WARNING
Status indicating a successful response that included at least one warning.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description String
getRequestId()
Returns the unique id for the request that generated this response.int
getStatus()
Returns the status for this response.boolean
isAvailable()
Returns true if a response is available, false otherwise.
-
-
-
Field Detail
-
STATUS_SUCCESS
static final int STATUS_SUCCESS
Status indicating a successful response.- See Also:
- Constant Field Values
-
STATUS_WARNING
static final int STATUS_WARNING
Status indicating a successful response that included at least one warning.- See Also:
- Constant Field Values
-
STATUS_FAILURE
static final int STATUS_FAILURE
Status indicating a failure response.- See Also:
- Constant Field Values
-
STATUS_UNAVAILABLE
static final int STATUS_UNAVAILABLE
Status indicating that the results are currently unavailable.- See Also:
- Constant Field Values
-
-
Method Detail
-
getRequestId
String getRequestId() throws JAXRException
Returns the unique id for the request that generated this response.- Capability Level: 0
- Returns:
- the request id
- Throws:
JAXRException
- If the JAXR provider encounters an internal error
-
getStatus
int getStatus() throws JAXRException
Returns the status for this response.- Capability Level: 0
- Returns:
- the status which is an integer enumerated value
- Throws:
JAXRException
- If the JAXR provider encounters an internal error- See Also:
STATUS_SUCCESS
-
isAvailable
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:
true
if the response is available;false
otherwise- Throws:
JAXRException
- If the JAXR provider encounters an internal error
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/xml/registry/jaxrresponse.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.