com.iplanet.am.sdk
クラス AMSearchResults

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

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

public class AMSearchResults
extends Object

This class AMSearchResults provides to obtain the search results.

フィールドの概要

protected int	errorCode 推奨されていません。
protected Map	resultsMap 推奨されていません。
protected Set	searchResults 推奨されていません。
static int	SIZE_LIMIT_EXCEEDED 推奨されていません。 Code used to indicate that the search was unsuccessful as the size limit exceeded during the search process.
static int	SUCCESS 推奨されていません。 Code used to indicate a successful search
static int	TIME_LIMIT_EXCEEDED 推奨されていません。 Code used to indicate that the search was unsuccessful as the time limit exceeded during the search process.
static int	UNDEFINED_RESULT_COUNT 推奨されていません。 Value returned when the total number of search results could not be obtained.
protected int	vlvResponseCount 推奨されていません。

コンストラクタの概要

AMSearchResults(int count, Set results, int errorCode, Map map)
推奨されていません。 Constructs the AMSearchResults object.

メソッドの概要

int	getErrorCode() 推奨されていません。 Method which returns the error code of search.
Map	getResultAttributes() 推奨されていません。 Method which returns the search results as a map containing DN's as key and the attribute value String.
Set	getSearchResults() 推奨されていません。 Method which returns the search results as an ordered set.
int	getTotalResultCount() 推奨されていません。 Method which returns the count of the all the results which match the search criteria.

フィールドの詳細

SUCCESS

public static final int SUCCESS

推奨されていません。

Code used to indicate a successful search

関連項目:

定数フィールド値

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED

推奨されていません。

Code used to indicate that the search was unsuccessful as the size limit exceeded during the search process.

関連項目:

定数フィールド値

TIME_LIMIT_EXCEEDED

public static final int TIME_LIMIT_EXCEEDED

推奨されていません。

Code used to indicate that the search was unsuccessful as the time limit exceeded during the search process.

関連項目:

定数フィールド値

UNDEFINED_RESULT_COUNT

public static final int UNDEFINED_RESULT_COUNT

推奨されていません。

Value returned when the total number of search results could not be obtained.

関連項目:

定数フィールド値

vlvResponseCount

protected int vlvResponseCount

推奨されていません。

searchResults

protected Set searchResults

推奨されていません。

resultsMap

protected Map resultsMap

推奨されていません。

errorCode

protected int errorCode

推奨されていません。

コンストラクタの詳細

AMSearchResults

public AMSearchResults(int count,
                       Set results,
                       int errorCode,
                       Map map)

推奨されていません。

Constructs the AMSearchResults object.

パラメータ:

count - Number of entries

results - Set of DNs from the search

errorCode - Error Code

map - Map of attributes and values if requested for

メソッドの詳細

getResultAttributes

public Map getResultAttributes()

推奨されていません。

Method which returns the search results as a map containing DN's as key and the attribute value String. The attribute value

戻り値:

Map containing DN's as the key and Maps of attribute-values of the attributes specified as part of the search. The Maps contains attribute names as keys and Set containing values of those attributes. Returns an empty Map if no attributes were specified as part of search request.

getSearchResults

public Set getSearchResults()

推奨されていません。

Method which returns the search results as an ordered set.

戻り値:

Set of DNs of matching the search criteria

getTotalResultCount

public int getTotalResultCount()

推奨されていません。

Method which returns the count of the all the results which match the search criteria.

戻り値:

total count of results matching the VLV search. Other wise returns UNDEFINED_RESULT_COUNT

関連項目:

AMSearchResults.UNDEFINED_RESULT_COUNT

getErrorCode

public int getErrorCode()

推奨されていません。

Method which returns the error code of search.

戻り値:

Error code of search. The possible values are SUCCESS, SIZE_LIMIT_EXCEEDED and TIME_LIMIT_EXCEEDED

関連項目:

AMSearchResults.SUCCESS, AMSearchResults.SIZE_LIMIT_EXCEEDED, AMSearchResults.TIME_LIMIT_EXCEEDED