Class DataProviderResponse


  • public class DataProviderResponse
    extends java.lang.Object

    The response returned by the DataProvider.request(int, java.lang.String) and DataProvider.discard(int, java.lang.String) methods. This response indicates whether the DataProvider is able to provide data for a requested object name, or is currently providing the data for a discarded object name.

    This class contains static instances if the available responses.

    The possible responses are:

    • OK
    • Deny
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static DataProviderResponse DENY
      The DataProvider is unable to provide the requested object.
      static DataProviderResponse OK
      The DataProvider is able to provide the requested object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets the description of the response.
      int getResponseCode()
      Gets the response code that the Transformer core will use to determine whether a DataProvider is able provide the requested data or not.
      java.lang.String toString()
      Returns a string that describes the DataProviderResponse, including its description and code.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • DENY

        public static final DataProviderResponse DENY

        The DataProvider is unable to provide the requested object.

      • OK

        public static final DataProviderResponse OK

        The DataProvider is able to provide the requested object.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()

        Gets the description of the response.

        Returns:
        The response's description.
      • getResponseCode

        public int getResponseCode()

        Gets the response code that the Transformer core will use to determine whether a DataProvider is able provide the requested data or not.

        The possible values are:

        • 0 - OK
        • -1 - Deny
        Returns:
        The response's code.
      • toString

        public java.lang.String toString()

        Returns a string that describes the DataProviderResponse, including its description and code.

        Overrides:
        toString in class java.lang.Object
        Returns:
        A string that represents the DataProviderResponse.