Class DataRetrievalRequest

  • All Implemented Interfaces:
    Serializable, Cloneable, Map

    public class DataRetrievalRequest
    extends HashMap
    Allow to specify options/parameters for getData request. The list is extensible based on the information needed for the Data Locator to process the request.
    See Also:
    Serialized Form
    • Field Detail

      • IDENTIFIER

        public static final String IDENTIFIER
        Key used to defined Identify of data to be retrieved.
        See Also:
        Constant Field Values
      • OUTPUT_FORM

        public static final String OUTPUT_FORM
        Key used to define the output format of retrieved data to be returned.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DataRetrievalRequest

        public DataRetrievalRequest()
    • Method Detail

      • getIdentifier

        public String getIdentifier()
        Returns the Identifier value specified in the request.
        Returns:
        a String that has Identifier info.
      • getOutputForm

        public OutputForm getOutputForm()
        Returns the output format specified in the request.
        Returns:
        output format of data retrieved.
      • putIdentifier

        public void putIdentifier​(String identifier)
        Allow to set the identifier of data to retrieve
        Parameters:
        identifier - - identifier value
        Throws:
        DataRetrievalException
      • putOutputForm

        public void putOutputForm​(OutputForm form)
        Allow to set the output format of the data retrieved.
        Parameters:
        form - - Valid output format types supported by the Data Locator.
        Throws:
        DataRetrievalException