Enum Class OrgScopeType
- All Implemented Interfaces:
TypeSafeEnum
,Serializable
,Comparable<OrgScopeType>
,Constable
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 ConstantDescriptionAll ancestors of the reference node, including ancestors of ancestors.All descendants of the reference node, including descendants of descendants.Direct descendants of the reference node.No objects belong to the scope. -
Method Summary
Modifier and TypeMethodDescriptionstatic OrgScopeType
value()
Returns enum value defined as in schema.static OrgScopeType
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.
-
Enum Constant Details
-
DIRECT_DESCENDANTS
Direct descendants of the reference node. I.e. all the nodes that are exactly one level below. -
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
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
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
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
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 nameNullPointerException
- if the argument is null
-
value
Description copied from interface:TypeSafeEnum
Returns enum value defined as in schema.- Specified by:
value
in interfaceTypeSafeEnum
- Returns:
-
fromValue
-