Package com.evolveum.midpoint.schema

Enum Class RetrieveOption

java.lang.Object

java.lang.Enum<RetrieveOption>

com.evolveum.midpoint.schema.RetrieveOption

All Implemented Interfaces:

Serializable, Comparable<RetrieveOption>, Constable

public enum RetrieveOption
extends Enum<RetrieveOption>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Return the item "as usual".
EXCLUDE	Exclude the item from the result.
INCLUDE	Include the item in the result.

Method Summary

Modifier and Type	Method	Description
static RetrieveOption	fromRetrieveOptionType(RetrieveOptionType retrieveOptionType)
static RetrieveOptionType	toRetrieveOptionType(RetrieveOption retrieveOption)
static RetrieveOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RetrieveOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final RetrieveOption DEFAULT

Return the item "as usual". If the item would be returned by default then return it. If the item would not be returned by default then it may not be returned.

INCLUDE

public static final RetrieveOption INCLUDE

Include the item in the result. The item will be returned (even if it would not be returned by default).

EXCLUDE

public static final RetrieveOption EXCLUDE

Exclude the item from the result.

Method Details

values

public static RetrieveOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RetrieveOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromRetrieveOptionType

public static RetrieveOption fromRetrieveOptionType(RetrieveOptionType retrieveOptionType)

toRetrieveOptionType

public static RetrieveOptionType toRetrieveOptionType(RetrieveOption retrieveOption)