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

Enum Class OrgScopeType

java.lang.Object

java.lang.Enum<OrgScopeType>

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

All Implemented Interfaces:

TypeSafeEnum, Serializable, Comparable<OrgScopeType>, Constable

public enum OrgScopeType
extends Enum<OrgScopeType>
implements TypeSafeEnum

Defines applicability scope in the organizational structures.

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
ALL_ANCESTORS	All ancestors of the reference node, including ancestors of ancestors.
ALL_DESCENDANTS	All descendants of the reference node, including descendants of descendants.
DIRECT_DESCENDANTS	Direct descendants of the reference node.
NONE	No objects belong to the scope.

Method Summary

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

DIRECT_DESCENDANTS

public static final OrgScopeType DIRECT_DESCENDANTS

Direct descendants of the reference node. I.e. all the nodes that are exactly one level below.

ALL_DESCENDANTS

public static final OrgScopeType ALL_DESCENDANTS

All descendants of the reference node, including descendants of descendants. I.e. all the nodes that are one or more levels below.

ALL_ANCESTORS

public static final OrgScopeType ALL_ANCESTORS

All ancestors of the reference node, including ancestors of ancestors. I.e. all the nodes that are on any path between the reference node and the root node.

NONE

public static final OrgScopeType NONE

No objects belong to the scope. Used in conjunction with includeReferenceOrg option to target only the reference node and no other node in the hierarchy.

Method Details

values

public static OrgScopeType[] 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 OrgScopeType 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 OrgScopeType fromValue(String v)