|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.idm.IdSearchResults
public class IdSearchResults
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 |
---|
public static final int SUCCESS
public static final int SIZE_LIMIT_EXCEEDED
public static final int TIME_LIMIT_EXCEEDED
protected Set searchResults
protected Map resultsMap
protected int errorCode
Constructor Detail |
---|
public IdSearchResults(IdType type, String orgName)
Method Detail |
---|
public Map getResultAttributes()
public Set 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()
public String toString()
IdSearchResults
object.
It returns identity names and attributes
toString
in class Object
ServiceConfig
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |