com.iplanet.am.sdk
Class AMSearchResults

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

Deprecated. As of Sun Java System Access Manager 7.1.

public class AMSearchResults
extends Object

This class AMSearchResults provides to obtain the search results.

Field Summary

protected int	errorCode Deprecated.
protected Map	resultsMap Deprecated.
protected Set	searchResults Deprecated.
static int	SIZE_LIMIT_EXCEEDED Deprecated. Code used to indicate that the search was unsuccessful as the size limit exceeded during the search process.
static int	SUCCESS Deprecated. Code used to indicate a successful search
static int	TIME_LIMIT_EXCEEDED Deprecated. Code used to indicate that the search was unsuccessful as the time limit exceeded during the search process.
static int	UNDEFINED_RESULT_COUNT Deprecated. Value returned when the total number of search results could not be obtained.
protected int	vlvResponseCount Deprecated.

Constructor Summary

AMSearchResults(int count, Set results, int errorCode, Map map)
Deprecated. Constructs the AMSearchResults object.

Method Summary

int	getErrorCode() Deprecated. Method which returns the error code of search.
Map	getResultAttributes() Deprecated. Method which returns the search results as a map containing DN's as key and the attribute value String.
Set	getSearchResults() Deprecated. Method which returns the search results as an ordered set.
int	getTotalResultCount() Deprecated. Method which returns the count of the all the results which match the search criteria.

Field Detail

SUCCESS

public static final int SUCCESS

Deprecated.

Code used to indicate a successful search

See Also:

Constant Field Values

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED

Deprecated.

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

See Also:

Constant Field Values

TIME_LIMIT_EXCEEDED

public static final int TIME_LIMIT_EXCEEDED

Deprecated.

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

See Also:

Constant Field Values

UNDEFINED_RESULT_COUNT

public static final int UNDEFINED_RESULT_COUNT

Deprecated.

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

See Also:

Constant Field Values

vlvResponseCount

protected int vlvResponseCount

Deprecated.

searchResults

protected Set searchResults

Deprecated.

resultsMap

protected Map resultsMap

Deprecated.

errorCode

protected int errorCode

Deprecated.

Constructor Detail

AMSearchResults

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

Deprecated.

Constructs the AMSearchResults object.

Parameters:

count - Number of entries

results - Set of DNs from the search

errorCode - Error Code

map - Map of attributes and values if requested for

Method Detail

getResultAttributes

public Map getResultAttributes()

Deprecated.

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

Returns:

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()

Deprecated.

Method which returns the search results as an ordered set.

Returns:

Set of DNs of matching the search criteria

getTotalResultCount

public int getTotalResultCount()

Deprecated.

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

Returns:

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

See Also:

AMSearchResults.UNDEFINED_RESULT_COUNT

getErrorCode

public int getErrorCode()

Deprecated.

Method which returns the error code of search.

Returns:

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

See Also:

AMSearchResults.SUCCESS, AMSearchResults.SIZE_LIMIT_EXCEEDED, AMSearchResults.TIME_LIMIT_EXCEEDED