ca.infoway.messagebuilder.domainvalue.payload
Class RoleStatus

java.lang.Object
  ca.infoway.messagebuilder.lang.Enum
      ca.infoway.messagebuilder.lang.EnumPattern
          ca.infoway.messagebuilder.domainvalue.payload.RoleStatus

All Implemented Interfaces:

Code, Describable, RoleStatus, Serializable, Comparable

public class RoleStatus
extends EnumPattern
implements RoleStatus, Describable

Codes representing the defined possible states of an Role, as defined by the Role class state machine.

Author:

BC Holmes

See Also:

Serialized Form

Field Summary

static RoleStatus	ACTIVE The state representing the fact that the Entity is currently active in the Role.
static RoleStatus	CANCELLED The terminal state resulting from cancellation of the role prior to activation.
static RoleStatus	NORMAL The 'typical' state.
static RoleStatus	NULLIFIED The state representing the termination of a Role instance that was created in error.
static RoleStatus	PENDING The state representing that fact that the role has not yet become active.
static RoleStatus	SUSPENDED The state that represents a suspension of the Entity playing the Role.
static RoleStatus	TERMINATED The state representing the successful termination of the Role.

Fields inherited from class ca.infoway.messagebuilder.lang.Enum

INNER_CLASS_SEPARATOR_CHAR, iToString, PACKAGE_SEPARATOR_CHAR

Method Summary

String	getCodeSystem() Gets the code system.
String	getCodeValue() Gets the code value.
String	getDescription() Gets the description.

Methods inherited from class ca.infoway.messagebuilder.lang.EnumPattern

getEnumConstants, isEnum, name, toString, valueOf, values

Methods inherited from class ca.infoway.messagebuilder.lang.Enum

compareTo, equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, getShortClassName, getShortClassName, hashCode, iterator, readResolve

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final RoleStatus NORMAL

The 'typical' state. Excludes "nullified" which represents the termination state of a Role instance that was created in error.

ACTIVE

public static final RoleStatus ACTIVE

The state representing the fact that the Entity is currently active in the Role.

CANCELLED

public static final RoleStatus CANCELLED

The terminal state resulting from cancellation of the role prior to activation.

PENDING

public static final RoleStatus PENDING

The state representing that fact that the role has not yet become active.

SUSPENDED

public static final RoleStatus SUSPENDED

The state that represents a suspension of the Entity playing the Role. This state is arrived at from the "active" state.

TERMINATED

public static final RoleStatus TERMINATED

The state representing the successful termination of the Role.

NULLIFIED

public static final RoleStatus NULLIFIED

The state representing the termination of a Role instance that was created in error.

Method Detail

getCodeSystem

public String getCodeSystem()

Gets the code system.

Specified by:

getCodeSystem in interface Code

Returns:

the code system

getCodeValue

public String getCodeValue()

Gets the code value.

Specified by:

getCodeValue in interface Code

Returns:

the code value

getDescription

public String getDescription()

Gets the description.

Specified by:

getDescription in interface Describable

Returns:

the description