Package org.odpi.openmetadata.frameworks.openmetadata.properties

Enum Class OpenMetadataRelationshipCategory

java.lang.Object

java.lang.Enum<OpenMetadataRelationshipCategory>

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRelationshipCategory

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataRelationshipCategory>, Constable

public enum OpenMetadataRelationshipCategory
extends Enum<OpenMetadataRelationshipCategory>

OpenMetadataRelationshipCategory is used in an OpenMetadataRelationshipDef to indicate how many relationships of this type can be connected between two element instances:

• UNI_LINK: Most common setting. Only one relationship of this type can be connected between two element instances in a specific direction. If a second relationship is connected between them in a specific direction, the properties of the original relationship are simply updated.
• REVERSIBLE: Relationship can be created in both directions between two elements. However, only one relationship will be stored and later "creates" will simply update the properties of the existing relationship.
• MULTI_LINK: Means that unlimited relationships of this type can be created between two elements. Updates to a relationship's properties need to use the updateRelationship call specifying the GUID of the relationship to change.

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
MULTI_LINK	Multiple relationships of a specific type are allowed between two elements in either direction.
REVERSIBLE	At most one relationship of a specific type is allowed between two elements in either direction.
UNI_LINK	Only one relationship of a specific type is allowed between two elements in a specific direction.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the cardinality.
String	getName()	Return the default name of the cardinality.
int	getOrdinal()	Return the numeric representation of the cardinality.
String	toString()	toString() JSON-style
static OpenMetadataRelationshipCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataRelationshipCategory[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNI_LINK

public static final OpenMetadataRelationshipCategory UNI_LINK

Only one relationship of a specific type is allowed between two elements in a specific direction.

REVERSIBLE

public static final OpenMetadataRelationshipCategory REVERSIBLE

At most one relationship of a specific type is allowed between two elements in either direction.

MULTI_LINK

public static final OpenMetadataRelationshipCategory MULTI_LINK

Multiple relationships of a specific type are allowed between two elements in either direction.

Method Details

values

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

getOrdinal

public int getOrdinal()

Return the numeric representation of the cardinality.

Returns:

int ordinal

getName

public String getName()

Return the default name of the cardinality.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the cardinality.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OpenMetadataRelationshipCategory>

Returns:

string description