API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.naming.directory. SearchControls View Source
Author(s)
Rosanna Lee
Scott Seligman
Since
1.3
Version
1.11 05/11/17
Serial
Hierarchy
 Object
      SearchControls
Implements
 Serializable
Subclasses
Description
public class SearchControls
  This class encapsulates factors that determine scope of search and what gets returned as a result of the search.
See also:   
Constructors
public SearchControls ()
  Constructs a search constraints using defaults.
public SearchControls (int scope, long countlim, int timelim, String attrs, boolean retobj, boolean deref)
  Constructs a search constraints using arguments.
Methods
Hide/Show inherited methods
public long getCountLimit ()
  Retrieves the maximum number of entries that will be returned as a result of the search.
public boolean getDerefLinkFlag ()
  Determines whether links will be dereferenced during the search.
public String getReturningAttributes ()
  Retrieves the attributes that will be returned as part of the search.
public boolean getReturningObjFlag ()
  Determines whether objects will be returned as part of the result.
public int getSearchScope ()
  Retrieves the search scope of these SearchControls.
public int getTimeLimit ()
  Retrieves the time limit of these SearchControls in milliseconds.
public void setCountLimit (long limit)
  Sets the maximum number of entries to be returned as a result of the search.
public void setDerefLinkFlag (boolean on)
  Enables/disables link dereferencing during the search.
public void setReturningAttributes (String attrs)
  Specifies the attributes that will be returned as part of the search.
public void setReturningObjFlag (boolean on)
  Enables/disables returning objects returned as part of the result.
public void setSearchScope (int scope)
  Sets the search scope to one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
public void setTimeLimit (int ms)
  Sets the time limit of these SearchControls in milliseconds.
Fields
Hide/Show inherited fields
publicfinalstatic int OBJECT_SCOPE = "0"
  Search the named object.
publicfinalstatic int ONELEVEL_SCOPE = "1"
  Search one level of the named context.
publicfinalstatic int SUBTREE_SCOPE = "2"
  Search the entire subtree rooted at the named object.
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar