Name

SearchControls

Synopsis

This class represents the information needed to control the behavior of the search() method of DirContext. Contains information that determines the scope of search, the maximum number of results returned by a search, the maximum amount of time permitted to return search results, and other data you can use to fine-tune the behavior of search operations.

                  
public class SearchControls implements Serializable {
// Public Constructors
   public SearchControls();  
   public SearchControls(int scope, long countlim, 
        int timelim, String[] attrs, 
        boolean retobj, boolean deref);  
// Public Constants
   public static final int OBJECT_SCOPE;                         // =0
   public static final int ONELEVEL_SCOPE;                       // =1
   public static final int SUBTREE_SCOPE;                        // =2
                  // Property Accessor Methods (by property name)
   public long getCountLimit();                                  // default:0
   public void setCountLimit( long limit);  
   public boolean getDerefLinkFlag();                            // default:false
   public void setDerefLinkFlag( boolean on);  
   public String[] getReturningAttributes();             // default:null
   public void setReturningAttributes(
        String[] attrs);  
   public boolean getReturningObjFlag();                         // default:false
   public void setReturningObjFlag( boolean on);  
   public int getSearchScope();                                  // default:1
   public void setSearchScope( int scope);  
   public int getTimeLimit();                                    // default:0
   public void setTimeLimit( int ms);  
}

Passed To

DirContext.search(), InitialDirContext.search() ...

Get Java Enterprise in a Nutshell, Second Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.