Package javax.xml.registry

Interface JAXRResponse

    • Field Summary

      Fields 
      Modifier and Type Field 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.

    • 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 Jakarta XML Registries 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 Jakarta XML Registries 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 Jakarta XML Registries provider encounters an internal error