com.iplanet.am.sdk
クラス AMSearchControl

java.lang.Object
  com.iplanet.am.sdk.AMSearchControl

推奨されていません。 As of Sun Java System Access Manager 7.1.

public class AMSearchControl
extends Object

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.

コンストラクタの概要

AMSearchControl()
推奨されていません。 Creates the AMSearchControl object

メソッドの概要

int	getMaxResults() 推奨されていません。 Returns the maximum number of search results. return 0 means there is no limit.
String[]	getReturnAttributes() 推奨されていません。 Returns the list of attributes requested to be read when the search is performed.
protected com.iplanet.ums.SearchControl	getSearchControl() 推奨されていません。
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.
protected String	getVLVJumpTo() 推奨されていません。 Returns jumpTo value for VLV range.
protected int[]	getVLVRange() 推奨されていません。 Get range for current VLV 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(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(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.
protected void	setVLVRange(int startIndex, int beforeCount, int afterCount) 推奨されていません。 Set range for retrieving VLV data.
protected void	setVLVRange(String jumpTo, int beforeCount, int afterCount) 推奨されていません。 Set range for retrieving VLV data.

コンストラクタの詳細

AMSearchControl

public AMSearchControl()

推奨されていません。

Creates the AMSearchControl object

メソッドの詳細

getSearchControl

protected com.iplanet.ums.SearchControl getSearchControl()

推奨されていません。

setReturnAttributes

public void setReturnAttributes(Set attributeNames)

推奨されていません。

Set the return attribute names, if attributes of the entries need to be obtained as part of the search. NOTE: If the return attribute values are specified as part of 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.

getReturnAttributes

public String[] getReturnAttributes()

推奨されていません。

Returns the list of attributes requested to be read when the search is performed.

戻り値:

list of attributes requested to be read.

setAllReturnAttributes

public void setAllReturnAttributes(boolean getAllAttributes)

推奨されていません。

Sets the specified boolean value to the variable. Boolean value is set to true, if all attributes of the entries need to be obtained as part of the search. NOTE: If this 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.

isGetAllReturnAttributesEnabled

public boolean isGetAllReturnAttributesEnabled()

推奨されていません。

Returns true if the option for getting all attributes has been enabled.

戻り値:

true if the option for getting all attributes has been enabled.

setSortKeys

public void setSortKeys(String[] attributeNames)

推奨されていません。

Set sort order based on attribute names.

パラメータ:

attributeNames - array of attribute names to sort on

setVLVRange

protected void setVLVRange(int startIndex,
                           int beforeCount,
                           int afterCount)

推奨されていません。

Set range for retrieving VLV data.

パラメータ:

startIndex - starting position.

beforeCount - Number of entries before the startIndex.

afterCount - Number of entries after the startIndex.

setVLVRange

protected void setVLVRange(String jumpTo,
                           int beforeCount,
                           int afterCount)

推奨されていません。

Set range for retrieving VLV data.

パラメータ:

jumpTo - Search expression defining the result set return.

beforeCount - Number of entries before the startIndex.

afterCount - Number of entries after the startIndex.

getVLVRange

protected int[] getVLVRange()

推奨されていません。

Get range for current VLV setting.

戻り値:

array of integers which contain startIndex, beforeCount and afterCount.

getVLVJumpTo

protected String getVLVJumpTo()

推奨されていません。

Returns jumpTo value for VLV range.

戻り値:

jumpTo value.

setTimeOut

public void setTimeOut(int timeOut)

推奨されていません。

Sets the maximum number of milliseconds to wait for any operation for the search.

パラメータ:

timeOut - Max number of milliseconds

getTimeOut

public int getTimeOut()

推奨されていません。

Returns current time out setting.

戻り値:

current time out setting.

setMaxResults

public void setMaxResults(int maxNumber)

推奨されていません。

Sets the maximum number of search results to return; 0 means there is no limit.

パラメータ:

maxNumber - Max number of results

getMaxResults

public int getMaxResults()

推奨されていません。

Returns the maximum number of search results. return 0 means there is no limit.

戻り値:

the maximum number of search results.

setSearchScope

public void setSearchScope(int scope)

推奨されていません。

Sets the search scope in AMSearchControl.

パラメータ:

scope - Search scope defined in the AMSearchControl to be used with the search API

getSearchScope

public int getSearchScope()

推奨されていません。

Gets the search scope defined in the AMSearchControl.

戻り値:

search scope defined in the AMSearchControl. If search scope is never defined in the AMSearchControl SCOPE_SUB for subtree type of search is assumed.

getSearchScope

public int getSearchScope(int defaultScope)

推奨されていません。

Gets the search scope defined in the 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

戻り値:

Search scope defined in the AMSearchControl. Return defaultScope if scope is not defined in the control.