Package org.ldaptive.templates

Class Query

  • public class Query
extends java.lang.Object
    Contains data associated with a query request.
    Author:
    Middleware Services

    • Constructor Summary

      Constructors 
      Constructor Description
      Query​(java.lang.String query)
      Parses the query from a string into query terms.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getFromResult()
      Returns the from result.
      java.lang.String[] getReturnAttributes()
      Returns the return attributes.
      java.lang.String getSearchRestrictions()
      Returns the search restrictions.
      java.lang.String[] getTerms()
      Returns the terms.
      java.lang.Integer getToResult()
      Returns the to result.
      void setFromResult​(java.lang.Integer i)
      Sets the index of the result to begin searching.
      void setReturnAttributes​(java.lang.String[] attrs)
      Sets the return attributes.
      void setSearchRestrictions​(java.lang.String restrictions)
      Sets the search restrictions.
      void setToResult​(java.lang.Integer i)
      Sets the index of the result to stop searching.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Query

        public Query​(java.lang.String query)
        Parses the query from a string into query terms.
        Parameters:
        query - to parse

    • Method Detail

      • getTerms

        public java.lang.String[] getTerms()
        Returns the terms.
        Returns:
        query terms

      • setReturnAttributes

        public void setReturnAttributes​(java.lang.String[] attrs)
        Sets the return attributes.
        Parameters:
        attrs - return attributes

      • getReturnAttributes

        public java.lang.String[] getReturnAttributes()
        Returns the return attributes.
        Returns:
        return attributes

      • setSearchRestrictions

        public void setSearchRestrictions​(java.lang.String restrictions)
        Sets the search restrictions.
        Parameters:
        restrictions - search restrictions

      • getSearchRestrictions

        public java.lang.String getSearchRestrictions()
        Returns the search restrictions.
        Returns:
        search restrictions

      • setFromResult

        public void setFromResult​(java.lang.Integer i)
        Sets the index of the result to begin searching.
        Parameters:
        i - from index

      • getFromResult

        public java.lang.Integer getFromResult()
        Returns the from result.
        Returns:
        from result

      • setToResult

        public void setToResult​(java.lang.Integer i)
        Sets the index of the result to stop searching.
        Parameters:
        i - to result

      • getToResult

        public java.lang.Integer getToResult()
        Returns the to result.
        Returns:
        to result

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object