|
|||||||||
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()
|
Method Summary | |
int |
getMaxResults()
Gets the maximum number of search results to return. |
java.lang.String[] |
getReturnAttributes()
|
int |
getSearchScope()
Gets the search scope defined in the AMSearchControl. |
int |
getSearchScope(int defaultScope)
Gets the search scope defined in the AMSearchControl. |
int |
getTimeOut()
Get current time out setting. |
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()
Method Detail |
public void setReturnAttributes(java.util.Set attributeNames)
attributeNames
- Set of attribute names whose values need to
be obtained as part of the search.public java.lang.String[] getReturnAttributes()
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)
scope
- Search scope defined in the AMSearchControl to
be used with the search APIpublic int getSearchScope()
public int getSearchScope(int defaultScope)
defaultScope
- Scope value to be used in case the
AMSearchControl is not set up with a search scope
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |