com.ibm.itim.remoteservices.provider

Class SearchCriteria

  • java.lang.Object
    • com.ibm.itim.remoteservices.provider.SearchCriteria
  • All Implemented Interfaces:
    java.io.Serializable

    public class SearchCriteria
extends java.lang.Object
implements java.io.Serializable
    Encapsulates search criteria used in performing a recon. The attributes of the search criteria are filter, base, and attributes to return.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      SearchCriteria()
      Creates an empty SearchCriteria object
      SearchCriteria(java.lang.String filter, java.lang.String base, java.util.Collection<java.lang.String> searchAttributes)
      Creates new SearchCriteria.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getBase()
      Accessor method for the search base.
      java.lang.String getFilter()
      Accessor method for the search filter.
      java.util.Collection<java.lang.String> getSearchAttributes()
      Gets the search attributes.
      boolean isEmpty()
      Determine if the search criteria is empty
      void setBase(java.lang.String base)
      Mutator method for the search base
      void setFilter(java.lang.String filter)
      Mutator method for the search filter
      void setSearchAttributes(java.util.Collection<java.lang.String> searchAttributes)
      Sets the search attributes.
      java.lang.String toString()
      Provides human readable description of the filter, base, and search criteria.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SearchCriteria

        public SearchCriteria()
        Creates an empty SearchCriteria object

      • SearchCriteria

        public SearchCriteria(java.lang.String filter,
                      java.lang.String base,
                      java.util.Collection<java.lang.String> searchAttributes)
        Creates new SearchCriteria. LDAP syntax is used for filter and base.
        Parameters:
        filter - A search filter, may be null
        base - The base to start the search at, may be null
        searchAttributes - Collection of Strings representing The list of names of attributes to return in the search

    • Method Detail

      • getSearchAttributes

        public java.util.Collection<java.lang.String> getSearchAttributes()
        Gets the search attributes. May be Null if not set.
        Returns:
        Collection of Strings representing The list of names of attributes to return in the search

      • setSearchAttributes

        public void setSearchAttributes(java.util.Collection<java.lang.String> searchAttributes)
        Sets the search attributes.
        Parameters:
        searchAttributes - Collection of Strings representing The list of names of attributes to return in the search

      • isEmpty

        public boolean isEmpty()
        Determine if the search criteria is empty
        Returns:
        True if there is no search filter, base, or searchAttributes

      • getFilter

        public java.lang.String getFilter()
        Accessor method for the search filter. May be Null if not set.
        Returns:
        The search filter

      • setFilter

        public void setFilter(java.lang.String filter)
        Mutator method for the search filter
        Parameters:
        filter - The search filter

      • getBase

        public java.lang.String getBase()
        Accessor method for the search base. May be Null if not set.
        Returns:
        the search base

      • setBase

        public void setBase(java.lang.String base)
        Mutator method for the search base
        Parameters:
        base - the search base

      • toString

        public java.lang.String toString()
        Provides human readable description of the filter, base, and search criteria.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The human readable description.
Skip navigation links