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

Enum Class RelationKindType

java.lang.Object

java.lang.Enum<RelationKindType>

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

All Implemented Interfaces:

TypeSafeEnum, Serializable, Comparable<RelationKindType>, Constable

public enum RelationKindType
extends Enum<RelationKindType>
implements TypeSafeEnum

Denotes a set of relations serving a single purpose. Until midPoint 3.9, there were fixed relations denoting e.g. manager of an organization (org:manager) or an approver of a role (org:approver). Starting with 3.9, relations are configurable, and each relation is characterized by its kind or sometimes a set of kinds. So we can have e.g. three approver relations (e:securityApprover, e:technicalApprover, e:businessApprover), a set of membership relations (org:default, e:assistant, e:external), etc. Note that here 'e' is a prefix for a custom namespace used to define these custom (extension) relations. Each relation has 0, 1 or more kinds. For example, the default org:manager relation is of MANAGER and MEMBERSHIP kinds. For each kind, there should be a single relation marked as the default one.

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
APPROVER	Relation "is approver of" kind.
CONSENT	Relation "is consent for" kind.
DELEGATION	Relation "is deputy of" kind.
MANAGER	Relations of "is manager of" kind.
MEMBER	Membership relation, usually meaning "has" or "is member of".
META	Relations used for metarole assignments.
OWNER	Relation "is owner of" kind.
RELATED	Relation "is related to" kind.

Method Summary

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

MEMBER

public static final RelationKindType MEMBER

Membership relation, usually meaning "has" or "is member of". Specifies that the subject is a member of organization, or that the subject has been assigned a role in a way that he gets authorizations and other content provided by that role. Default relation of MEMBERSHIP kind is also considered to be the overall default relation (i.e. used when ref.relation is null).

MANAGER

public static final RelationKindType MANAGER

Relations of "is manager of" kind. Specifies that the subject is a manager of organizational unit. Relations of this kind are usually also of MEMBERSHIP kind.

META

public static final RelationKindType META

Relations used for metarole assignments. Sometimes it is important to distinguish metarole and member assignments. This kind of relation is used for that purpose.

DELEGATION

public static final RelationKindType DELEGATION

Relation "is deputy of" kind. Specifies that the subject is a deputy of another user.

APPROVER

public static final RelationKindType APPROVER

Relation "is approver of" kind. Specifies that the subject is a (general) approver of specified (abstract) role. The approver will be asked for decision if the role is assigned, if there is a rule conflict during assignment (e.g. SoD conflict) or if there is any similar situation. This approver is responsible for the use of the role, which mostly means that he decides about role assignment. It is NOT meant to approve role changes. Role owner is meant for that purpose.

OWNER

public static final RelationKindType OWNER

Relation "is owner of" kind. Specifies that the subject is a (business) owner of specified (abstract) role. The owner will be asked for decision if the role is modified, when the associated policy changes and so on. This owner is responsible for maintaining role definition and policies. It is NOT necessarily concerned with role use (e.g. assignment). The approver relation kind is meant for that purpose.

CONSENT

public static final RelationKindType CONSENT

Relation "is consent for" kind. Specifies that the subject gave a consent for using personnel information related to this role.

RELATED

public static final RelationKindType RELATED

Relation "is related to" kind. Specifies that the subject is somewhat related to the owner, but this relation does not bring any specific privileges or entitlements or whatever to it. It is just a descriptive information, with no tangible effect. Currently used to link shadow owners to their dead shadows. We want to maintain such link but we do not want to show them e.g. in links counts etc.

Method Details

values

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