Interface ITextGetRequest

  • All Superinterfaces:
    IGetRequest
    All Known Subinterfaces:
    IOQLTextGetRequest, IXPathTextGetRequest

    public interface ITextGetRequest
    extends IGetRequest
    This interface represents a textual retrieval request. Implementations of this interface contain a textual retrieval text which will be parsed to determine which objects must be retrieved.
    • Method Detail

      • getQuery

        java.lang.String getQuery()
        Returns the retrieval text of this request.
      • setQuery

        void setQuery​(java.lang.String query)
        Sets the retrieval text of this request.
      • setParameters

        void setParameters​(IParameterMap parameterMap)
        Specifies the parameter values of the query.
        Parameters:
        parameterMap - the parameter values of the query
      • createParameterMap

        IParameterMap createParameterMap()
        Returns a new object to set parameter values for this query. This object must be set for the request by the method setParameters(..).
        Returns:
        a new object to set parameter values for this query
      • getParameters

        IParameterMap getParameters()
        Returns the object with parameters values.
        Returns:
        the parameter values of the query.