public class IdSearchResults extends Object
IdSearchResults
provides to obtain the search
results.Modifier and Type | Field and Description |
---|---|
protected int |
errorCode |
protected Map<AMIdentity,Map<String,?>> |
resultsMap |
protected Set<AMIdentity> |
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 and Description |
---|
IdSearchResults(IdType type,
String orgName) |
Modifier and Type | Method and Description |
---|---|
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<AMIdentity,Map<String,?>> |
getResultAttributes()
Method which returns the search results as a map containing AMIdentity
objects as key and the attribute value String.
|
Set<AMIdentity> |
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. |
public static final int SUCCESS
public static final int SIZE_LIMIT_EXCEEDED
public static final int TIME_LIMIT_EXCEEDED
protected Set<AMIdentity> searchResults
protected Map<AMIdentity,Map<String,?>> resultsMap
protected int errorCode
public Map<AMIdentity,Map<String,?>> getResultAttributes()
public Set<AMIdentity> getSearchResults()
public int getErrorCode()
SUCCESS
, SIZE_LIMIT_EXCEEDED
and
TIME_LIMIT_EXCEEDED
IdSearchResults.SUCCESS
,
IdSearchResults.SIZE_LIMIT_EXCEEDED
,
IdSearchResults.TIME_LIMIT_EXCEEDED
public void addResult(AMIdentity id, Map attrs)
id
- AMIdentity representing the entity.attrs
- Map of attrbibutes obtained while performing the searchpublic void setErrorCode(int error)
error
- Error code of Search Result.IdSearchResults.SUCCESS
,
IdSearchResults.SIZE_LIMIT_EXCEEDED
,
IdSearchResults.TIME_LIMIT_EXCEEDED
protected IdType getType()
protected String getOrgName()
Copyright © 2010-2017, ForgeRock All Rights Reserved.