|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.iplanet.am.sdk.AMSearchControl
public class 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()
Deprecated. Creates the AMSearchControl object |
Method Summary | |
---|---|
int |
getMaxResults()
Deprecated. Returns the maximum number of search results. |
String[] |
getReturnAttributes()
Deprecated. Returns the list of attributes requested to be read when the search is performed. |
protected com.iplanet.ums.SearchControl |
getSearchControl()
Deprecated. |
int |
getSearchScope()
Deprecated. Gets the search scope defined in the AMSearchControl . |
int |
getSearchScope(int defaultScope)
Deprecated. Gets the search scope defined in the AMSearchControl . |
int |
getTimeOut()
Deprecated. Returns current time out setting. |
protected String |
getVLVJumpTo()
Deprecated. Returns jumpTo value for VLV range. |
protected int[] |
getVLVRange()
Deprecated. Get range for current VLV setting. |
boolean |
isGetAllReturnAttributesEnabled()
Deprecated. Returns true if the option for getting all attributes has been enabled. |
void |
setAllReturnAttributes(boolean getAllAttributes)
Deprecated. Sets the specified boolean value to the variable. |
void |
setMaxResults(int maxNumber)
Deprecated. Sets the maximum number of search results to return; 0 means there is no limit. |
void |
setReturnAttributes(Set attributeNames)
Deprecated. Set the return attribute names, if attributes of the entries need to be obtained as part of the search. |
void |
setSearchScope(int scope)
Deprecated. Sets the search scope in AMSearchControl . |
void |
setSortKeys(String[] attributeNames)
Deprecated. Set sort order based on attribute names. |
void |
setTimeOut(int timeOut)
Deprecated. Sets the maximum number of milliseconds to wait for any operation for the search. |
protected void |
setVLVRange(int startIndex,
int beforeCount,
int afterCount)
Deprecated. Set range for retrieving VLV data. |
protected void |
setVLVRange(String jumpTo,
int beforeCount,
int afterCount)
Deprecated. Set range for retrieving VLV data. |
Constructor Detail |
---|
public AMSearchControl()
AMSearchControl
object
Method Detail |
---|
protected com.iplanet.ums.SearchControl getSearchControl()
public void setReturnAttributes(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 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(String[] attributeNames)
attributeNames
- array of attribute names to sort onprotected void setVLVRange(int startIndex, int beforeCount, int afterCount)
startIndex
- starting position.beforeCount
- Number of entries before the startIndex
.afterCount
- Number of entries after the startIndex
.protected void setVLVRange(String jumpTo, int beforeCount, int afterCount)
jumpTo
- Search expression defining the result set return.beforeCount
- Number of entries before the startIndex
.afterCount
- Number of entries after the startIndex
.protected int[] getVLVRange()
startIndex
,
beforeCount
and afterCount
.protected String getVLVJumpTo()
jumpTo
value for VLV range.
jumpTo
value.public 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
scope
AMSearchControl
.
Return defaultScope
if scope is not defined in the
control.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |