com.iplanet.am.sdk
Class AMSearchResults

java.lang.Object
  |
  +--com.iplanet.am.sdk.AMSearchResults

public class AMSearchResults

extends java.lang.Object

This class AMSearchResults provides to obtain the search results.

Field Summary

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.

Constructor Summary

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

Method Summary

int	getErrorCode() Method which returns the error code of search.
java.util.Map	getResultAttributes() Method which returns the search results as a map containing DN's as key and the attribute value String.
java.util.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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.

Constructor Detail

AMSearchResults

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

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 java.util.Map getResultAttributes()

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 java.util.Set getSearchResults()

Method which returns the search results as an ordered set.

Returns:

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.

Returns:

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

See Also:

UNDEFINED_RESULT_COUNT

getErrorCode

public int getErrorCode()

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:

SUCCESS, SIZE_LIMIT_EXCEEDED, TIME_LIMIT_EXCEEDED