| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.iplanet.am.sdk.AMSearchResults
This class AMSearchResults 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. | 
| static int | UNDEFINED_RESULT_COUNTValue returned when the total number of search results could not be obtained. | 
| Constructor Summary | |
| AMSearchResults(int count,
                java.util.Set results,
                int errorCode,
                java.util.Map map)Constructs the AMSearchResultsobject. | |
| Method Summary | |
|  int | getErrorCode()Method which returns the error code of search. | 
|  java.util.Map | getResultAttributes()Method which returns the search results as a map containing DN's as key and the attribute value String. | 
|  java.util.Set | getSearchResults()Method which returns the search results as an ordered set. | 
|  int | getTotalResultCount()Method which returns the count of the all the results which match the search criteria. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final int SUCCESS
public static final int SIZE_LIMIT_EXCEEDED
public static final int TIME_LIMIT_EXCEEDED
public static final int UNDEFINED_RESULT_COUNT
| Constructor Detail | 
public AMSearchResults(int count,
                       java.util.Set results,
                       int errorCode,
                       java.util.Map map)
AMSearchResults object.count - Number of entriesresults - Set of  DNs  from the searcherrorCode - Error Codemap - Map of attributes and values if requested for| Method Detail | 
public java.util.Map getResultAttributes()
public java.util.Set getSearchResults()
public int getTotalResultCount()
UNDEFINED_RESULT_COUNTpublic int getErrorCode()
SUCCESS, SIZE_LIMIT_EXCEEDED
 and TIME_LIMIT_EXCEEDEDSUCCESS, 
SIZE_LIMIT_EXCEEDED, 
TIME_LIMIT_EXCEEDED| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||