Package org.identityconnectors.framework.common.objects

Enum AttributeInfo.RoleInReference

java.lang.Object

java.lang.Enum<AttributeInfo.RoleInReference>

org.identityconnectors.framework.common.objects.AttributeInfo.RoleInReference

All Implemented Interfaces:

Serializable, Comparable<AttributeInfo.RoleInReference>

Enclosing class:

AttributeInfo

public static enum AttributeInfo.RoleInReference
extends Enum<AttributeInfo.RoleInReference>

The role of an object in the relationship (provided by specific reference attribute). We call this object a "holder" below.

See Also:

AttributeInfo.getRoleInReference()

Enum Constant Summary

Enum Constants

Enum Constant	Description
OBJECT	The holder can be considered an object of the relationship.
SUBJECT	The holder can be considered a subject of the relationship.

Method Summary

Modifier and Type	Method	Description
String	toString()
static AttributeInfo.RoleInReference	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeInfo.RoleInReference[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUBJECT

public static final AttributeInfo.RoleInReference SUBJECT

The holder can be considered a subject of the relationship. It is the usual source (starting point) of relationship navigation, i.e. we usually ask "what objects does the subject hold", not the way around. Typical example: account or other type of group member (when regarding group membership relation).

OBJECT

public static final AttributeInfo.RoleInReference OBJECT

The holder can be considered an object of the relationship. It is the usual target (ending point) of relationship navigation. Typical example: the group that has some members (when regarding group membership relation).

Method Detail

values

public static AttributeInfo.RoleInReference[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AttributeInfo.RoleInReference c : AttributeInfo.RoleInReference.values())
    System.out.println(c);

Returns:

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

valueOf

public static AttributeInfo.RoleInReference valueOf(String name)

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<AttributeInfo.RoleInReference>