com.sun.identity.idm
Class IdSearchResults

java.lang.Object
  com.sun.identity.idm.IdSearchResults

public class IdSearchResults
extends Object

This class IdSearchResults provides to obtain the search results.

Field Summary

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.

Constructor Summary

IdSearchResults(IdType type, String orgName)

Method Summary

void	addResult(AMIdentity id, Map attrs) Adds an AMIdentity object to this search result.
int	getErrorCode() Method which returns the error code of search.
protected String	getOrgName()
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.
protected IdType	getType()
void	setErrorCode(int error) Set the error code for this Search Result
String	toString() Returns String representation of the IdSearchResults object.

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

searchResults

protected Set searchResults

resultsMap

protected Map resultsMap

errorCode

protected int errorCode

Constructor Detail

IdSearchResults

public IdSearchResults(IdType type,
                       String orgName)

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 AMIdentity objects as the key and Maps of attribute-valuesof 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 AMIdentity objects 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:

IdSearchResults.SUCCESS, IdSearchResults.SIZE_LIMIT_EXCEEDED, IdSearchResults.TIME_LIMIT_EXCEEDED

addResult

public void addResult(AMIdentity id,
                      Map attrs)

Adds an AMIdentity object to this search result.

Parameters:

id - AMIdentity representing the entity.

attrs - Map of attrbibutes obtained while performing the search

setErrorCode

public void setErrorCode(int error)

Set the error code for this Search Result

Parameters:

error - Error code of Search Result.

See Also:

IdSearchResults.SUCCESS, IdSearchResults.SIZE_LIMIT_EXCEEDED, IdSearchResults.TIME_LIMIT_EXCEEDED

getType

protected IdType getType()

getOrgName

protected String getOrgName()

toString

public String toString()

Returns String representation of the IdSearchResults object. It returns identity names and attributes

Overrides:

toString in class Object

Returns:

String representation of the ServiceConfig object.