org.apache.directory.shared.ldap.message
Class SearchParams
java.lang.Object
org.apache.directory.shared.ldap.message.SearchParams
public class SearchParams
- extends java.lang.Object
A container for Search parameters. It replaces the SearchControls.
- Version:
- $Rev$, $Date$
- Author:
- Apache Directory Project
Constructor Summary |
SearchParams()
Creates a new instance of SearchContext, with all the values set to
default. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
SearchParams
public SearchParams()
- Creates a new instance of SearchContext, with all the values set to
default.
getScope
public SearchScope getScope()
- Returns:
- the scope
setScope
public void setScope(SearchScope scope)
- Parameters:
scope
- the scope to set
getTimeLimit
public int getTimeLimit()
- Returns:
- the timeLimit
setTimeLimit
public void setTimeLimit(int timeLimit)
- Parameters:
timeLimit
- the timeLimit to set
getSizeLimit
public long getSizeLimit()
- Returns:
- the sizeLimit
setSizeLimit
public void setSizeLimit(long sizeLimit)
- Parameters:
sizeLimit
- the sizeLimit to set
isTypesOnly
public boolean isTypesOnly()
- Returns:
- the typesOnly
setTypesOnly
public void setTypesOnly(boolean typesOnly)
- Parameters:
typesOnly
- the typesOnly to set
getAliasDerefMode
public AliasDerefMode getAliasDerefMode()
- Returns:
- the aliasDerefMode
setAliasDerefMode
public void setAliasDerefMode(AliasDerefMode aliasDerefMode)
- Parameters:
aliasDerefMode
- the aliasDerefMode to set
getReturningAttributes
public java.util.Set<AttributeTypeOptions> getReturningAttributes()
- Returns:
- the returningAttributes
getReturningAttributesStr
public java.util.Set<java.lang.String> getReturningAttributesStr()
- Returns:
- the returningAttributes
normalize
public void normalize(SchemaManager schemaManager)
- Normalize the ReturningAttributes. It reads all the String from the returningAttributesString,
and grab the associated AttributeType from the schema to store it into the returningAttributes
Set.
- Parameters:
schemaManager
- The schema manager
setReturningAttributes
public void setReturningAttributes(java.lang.String... returningAttributes)
- Parameters:
returningAttributes
- the returningAttributes to set
addReturningAttributes
public void addReturningAttributes(java.lang.String returningAttribute)
- Parameters:
returningAttribute
- the returningAttributes to add
getControls
public java.util.Set<Control> getControls()
- Returns:
- the controls
setControls
public void setControls(java.util.Set<Control> controls)
- Parameters:
controls
- the controls to set
addControl
public void addControl(Control control)
- Parameters:
controls
- the controls to set
getSearchControls
public javax.naming.directory.SearchControls getSearchControls()
toSearchParams
public static SearchParams toSearchParams(javax.naming.directory.SearchControls searchControls,
AliasDerefMode aliasDerefMode)
toString
public java.lang.String toString()
-
- Overrides:
toString
in class java.lang.Object
Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.