|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.am.sdk.AMSearchControl
This class provides a way to customize Search behaviors. Common
behaviors are time limit, result limit and Virtual list view.
In future, we will provide ways for client to define different
hierarchical tree through AMSearchControl
.
Constructor Summary | |
AMSearchControl()
Creates the AMSearchControl object |
Method Summary | |
int |
getMaxResults()
Returns the maximum number of search results. |
java.lang.String[] |
getReturnAttributes()
This method returns the list of attributes requested to be read when the search is performed. |
int |
getSearchScope()
Gets the search scope defined in the AMSearchControl . |
int |
getSearchScope(int defaultScope)
Gets the search scope defined in the AMSearchControl . |
int |
getTimeOut()
Returns current time out setting. |
boolean |
isGetAllReturnAttributesEnabled()
Returns true if the option for getting all attributes has been enabled. |
void |
setAllReturnAttributes(boolean getAllAttributes)
Sets the specified boolean value to the variable. |
void |
setMaxResults(int maxNumber)
Sets the maximum number of search results to return; 0 means there is no limit. |
void |
setReturnAttributes(java.util.Set attributeNames)
Set the return attribute names, if attributes of the entries need to be obtained as part of the search. |
void |
setSearchScope(int scope)
Sets the search scope in AMSearchControl . |
void |
setSortKeys(java.lang.String[] attributeNames)
Set sort order based on attribute names. |
void |
setTimeOut(int timeOut)
Sets the maximum number of milliseconds to wait for any operation for the search. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AMSearchControl()
AMSearchControl object
Method Detail |
public void setReturnAttributes(java.util.Set attributeNames)
AMSearchControl
, there could be a significant performance
overhead compared to when none are specified. When the return
attributes are set, the return attributes can be obtained as
a map with DN as map-key and set of attribute values as map-value
from AMSearchResults
object.attributeNames
- Set of attribute names whose values need to
be obtained as part of the search.public java.lang.String[] getReturnAttributes()
public void setAllReturnAttributes(boolean getAllAttributes)
getAllReturnAttributes
boolean is set to true
as part of AMSearchControl
, it overrides any other
setReturnAttributes
set as part of the AMSearchControl
.
This is similar to using a wildcard '*' in search.
When the option for getting all attributes is set to true, the search
results will return a Map,
where the Key is the DN of the search results, and value is another Map
of attribute names for keys
and Sets for values of those attributes.getAllAttributes
- Boolean value set to true as part
of the AMSearchControl to obtain all attributes
as part of the search.public boolean isGetAllReturnAttributesEnabled()
public void setSortKeys(java.lang.String[] attributeNames)
attributeNames
- array of attribute names to sort onpublic void setTimeOut(int timeOut)
timeOut
- Max number of millisecondspublic int getTimeOut()
public void setMaxResults(int maxNumber)
maxNumber
- Max number of resultspublic int getMaxResults()
public void setSearchScope(int scope)
AMSearchControl
.scope
- Search scope defined in the AMSearchControl
to
be used with the search APIpublic int getSearchScope()
AMSearchControl
.AMSearchControl
.
If search scope is never defined in the
AMSearchControl
SCOPE_SUB
for
subtree type of search is assumed.public int getSearchScope(int defaultScope)
AMSearchControl
. Allows
a user to specify default search scope if nothing has been
defined in the AMSearchControl
yet.defaultScope
- Scope value to be used in case the
AMSearchControl
is not set up with a search scopeAMSearchControl
. Return
defaultScope
if scope is not defined in the control.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |