com.sun.identity.idm
Class  IdSearchResults
java.lang.Object
  |
  +--com.sun.identity.idm.IdSearchResults
- public class IdSearchResults- extends java.lang.Object
This class IdSearchResults provides to obtain the search 
 results.
| Field Summary | 
| static int | SIZE_LIMIT_EXCEEDEDCode used to indicate that the search was unsuccessful 
  as the size limit exceeded during the search process.
 | 
| static int | SUCCESSCode used to indicate a successful search
 | 
| static int | TIME_LIMIT_EXCEEDEDCode used to indicate that the search was unsuccessful 
  as the time limit exceeded during the search process.
 | 
 
 
| Method Summary | 
|  void | addResult(AMIdentity id,
          java.util.Map attrs)Adds an AMIdentity object to this search result.
 | 
|  int | getErrorCode()Method which returns the error code of search.
 | 
|  java.util.Map | getResultAttributes()Method which returns the search results as a map containing
 AMIdentity objects as key and the attribute value String.
 | 
|  java.util.Set | getSearchResults()Method which returns the search results as an ordered set.
 | 
|  void | setErrorCode(int error)Set the error code for this Search Result
 | 
 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
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.
IdSearchResults
public IdSearchResults(IdType type,
                       java.lang.String orgName)
getResultAttributes
public java.util.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 java.util.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_EXCEEDEDandTIME_LIMIT_EXCEEDED
- See Also: 
- SUCCESS,- SIZE_LIMIT_EXCEEDED,- TIME_LIMIT_EXCEEDED
 
addResult
public void addResult(AMIdentity id,
                      java.util.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: 
- SUCCESS,- SIZE_LIMIT_EXCEEDED,- TIME_LIMIT_EXCEEDED
 
Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.