com.sun.identity.policy
Class ValidValues

java.lang.Object
  |
  +--com.sun.identity.policy.ValidValues

public class ValidValues
extends java.lang.Object

This class ValidValues provides search results and a error code indicating if the search was successfully or time limit exceeded or search limit exceeded.


Field Summary
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
ValidValues(int errorCode, java.util.Set results)
          Constructs a ValidValues given errorCode and a set of values
 
Method Summary
 int getErrorCode()
          Method which returns the error code of search.
 java.util.Set getSearchResults()
          Method which returns the search results as a set.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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.
Constructor Detail

ValidValues

public ValidValues(int errorCode,
                   java.util.Set results)
Constructs a ValidValues given errorCode and a set of values
Parameters:
errorCode - error code
results - set of values to be included
See Also:
SUCCESS, SIZE_LIMIT_EXCEEDED, TIME_LIMIT_EXCEEDED
Method Detail

getSearchResults

public java.util.Set getSearchResults()
Method which returns the search results as a set.
Returns:
Set of entries matching the search criteria. Each element in the Set is a String.

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:
SUCCESS, SIZE_LIMIT_EXCEEDED, TIME_LIMIT_EXCEEDED


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.