Package org.identityconnectors.framework.common.objects

Enum SearchResult.CountPolicy

java.lang.Object

java.lang.Enum<SearchResult.CountPolicy>

org.identityconnectors.framework.common.objects.SearchResult.CountPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchResult.CountPolicy>

Enclosing class:

SearchResult

public static enum SearchResult.CountPolicy
extends java.lang.Enum<SearchResult.CountPolicy>

An enum of count policy types.

See Also:

OperationOptionsBuilder.setTotalPagedResultsPolicy(CountPolicy), SearchResult.getTotalPagedResultsPolicy()

Enum Constant Summary

Enum Constants

Enum Constant	Description
ESTIMATE	Estimated count may be used.
EXACT	Exact count is required.
NONE	There should be no count returned.

Method Summary

Modifier and Type	Method	Description
static SearchResult.CountPolicy	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SearchResult.CountPolicy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SearchResult.CountPolicy NONE

There should be no count returned. No overhead should be incurred.

ESTIMATE

public static final SearchResult.CountPolicy ESTIMATE

Estimated count may be used. If no estimation is available it is up to the implementor whether to return an EXACT count or NONE. It should be known to the client which was used as in SearchResult.getTotalPagedResultsPolicy()

EXACT

public static final SearchResult.CountPolicy EXACT

Exact count is required.

Method Detail

values

public static SearchResult.CountPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchResult.CountPolicy c : SearchResult.CountPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchResult.CountPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null