Package org.kuali.rice.krms.api.repository.typerelation

Enum Class RelationshipType

java.lang.Object

java.lang.Enum<RelationshipType>

org.kuali.rice.krms.api.repository.typerelation.RelationshipType

All Implemented Interfaces:

Serializable, Comparable<RelationshipType>, Constable, Coded

public enum RelationshipType
extends Enum<RelationshipType>
implements Coded

Enumeration for RelationshipTypes. USAGE_ALLOWED or UNKNOWN.

Author:

Kuali Rice Team (rice.collab@kuali.org)

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
UNKNOWN	use this flag with the static factory to get a RelationshipType Unknown
USAGE_ALLOWED	use this flag with the static factory to get a RelationshipType Usage Allowed

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	VALID_TYPE_CODES	Set of valid type codes

Method Summary

Modifier and Type	Method	Description
static RelationshipType	fromCode(String code)	Create a RelationshipType for the given code
String	getCode()	Returns the operator code for this evaluation operator.
static RelationshipType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationshipType[]	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

UNKNOWN

public static final RelationshipType UNKNOWN

use this flag with the static factory to get a RelationshipType Unknown

USAGE_ALLOWED

public static final RelationshipType USAGE_ALLOWED

use this flag with the static factory to get a RelationshipType Usage Allowed

Field Details

VALID_TYPE_CODES

public static final Set<String> VALID_TYPE_CODES

Set of valid type codes

Method Details

values

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

getCode

public String getCode()

Returns the operator code for this evaluation operator.

Specified by:

getCode in interface Coded

Returns:

the operatorCode

fromCode

public static RelationshipType fromCode(String code)

Create a RelationshipType for the given code

Parameters:

code - to type the RelationshipType

Returns:

RelationshipType of the given code

Throws:

IllegalArgumentException - if the given code does not exist