Package com.evolveum.midpoint.xml.ns._public.common.common_3

Enum Class SearchHierarchyScopeType

java.lang.Object

java.lang.Enum<SearchHierarchyScopeType>

com.evolveum.midpoint.xml.ns._public.common.common_3.SearchHierarchyScopeType

All Implemented Interfaces:

TypeSafeEnum, Serializable, Comparable<SearchHierarchyScopeType>, Constable

public enum SearchHierarchyScopeType
extends Enum<SearchHierarchyScopeType>
implements TypeSafeEnum

Definition of search hierarchy scope. It specifies how "deep" the search should go into the object hierarchy. It is only applicable to resources that support hierarchical organization of objects (e.g. LDAP resources).

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
ONE	One-level search.
SUB	Subtree search.

Method Summary

Modifier and Type	Method	Description
static SearchHierarchyScopeType	fromValue(String v)
String	value()	Returns enum value defined as in schema.
static SearchHierarchyScopeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchHierarchyScopeType[]	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

SUB

public static final SearchHierarchyScopeType SUB

Subtree search. The search go deep down the hierarchy, as deep as possible.

ONE

public static final SearchHierarchyScopeType ONE

One-level search. The search is reaching just one level below the base context object.

Method Details

values

public static SearchHierarchyScopeType[] 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 SearchHierarchyScopeType 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

value

public String value()

Description copied from interface: TypeSafeEnum

Returns enum value defined as in schema.

Specified by:

value in interface TypeSafeEnum

Returns:

fromValue

public static SearchHierarchyScopeType fromValue(String v)