Package com.sun.identity.idm

Class RepoSearchResults

java.lang.Object

com.sun.identity.idm.RepoSearchResults

public class RepoSearchResults
extends Object

This class RepoSearchResults provides to obtain the search results.

Field Summary

Fields

Modifier and Type	Field	Description
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.

Constructor Summary

Constructors

Constructor	Description
RepoSearchResults(Set results, int errorCode, Map map, IdType type)	Constructs the RepoSearchResults object.

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Method which returns the error code of search.
Map	getResultAttributes()	Method which returns the search results as a map containing AMIdentity objects as key and the attribute value String.
Set	getSearchResults()	Method which returns the search results as an ordered set.
IdType	getType()

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

Code used to indicate a successful search

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

UNDEFINED_RESULT_COUNT

public static final int UNDEFINED_RESULT_COUNT

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

See Also:

Constant Field Values

searchResults

protected Set searchResults

resultsMap

protected Map resultsMap

errorCode

protected int errorCode

Constructor Detail

RepoSearchResults

public RepoSearchResults(Set results,
                         int errorCode,
                         Map map,
                         IdType type)

Constructs the RepoSearchResults object.

Parameters:

type - search for IdType

results - Set of names from the search

errorCode - Error Code

map - Map of attributes and values if requested for

Method Detail

getResultAttributes

public Map getResultAttributes()

Method which returns the search results as a map containing AMIdentity objects as key and the attribute value String. The attribute value is a Set.

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

Method which returns the search results as an ordered set.

Returns:

Set of DNs of matching the search criteria

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

getType

public IdType getType()