com.sun.identity.policy
Class ValidValues

java.lang.Object
  com.sun.identity.policy.ValidValues

public class ValidValues
extends 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, Set results)
Constructs a ValidValues given errorCode and a set of values

Method Summary

int	getErrorCode() Returns the error code of search.
Set	getSearchResults() Returns the search results as a set.

Field Detail

SUCCESS

public static final int SUCCESS

Code used to indicate a successful search

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

Constructor Detail

ValidValues

public ValidValues(int errorCode,
                   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:

ValidValues.SUCCESS, ValidValues.SIZE_LIMIT_EXCEEDED, ValidValues.TIME_LIMIT_EXCEEDED

Method Detail

getSearchResults

public Set getSearchResults()

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()

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:

ValidValues.SUCCESS, ValidValues.SIZE_LIMIT_EXCEEDED, ValidValues.TIME_LIMIT_EXCEEDED