ManagedParticipationStatus

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.hl7.types.enums
Enum ManagedParticipationStatus

java.lang.Object
  java.lang.Enum<ManagedParticipationStatus>
      org.hl7.types.enums.ManagedParticipationStatus

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<ManagedParticipationStatus>, ANY, CD, CE, CS, CV

public enum ManagedParticipationStatus
extends java.lang.Enum<ManagedParticipationStatus>
implements CS
extends java.lang.Enum<ManagedParticipationStatus>
implements CS

Codes representing the defined possible states of a Managed Participation, as defined by the Managed Participation class state machine.

This table controls values for structural elements of the HL7 Reference Information Model. Therefore, it is part of the Normative Ballot for the RIM.

Enum Constant Summary
`Active` The state representing the fact that the Participation is in progress.
`Cancelled` The terminal state resulting from cancellation of the Participation prior to activation.
`Completed` The terminal state representing the successful completion of the Participation.
`Normal` The 'typical' state.
`Nullified` The state representing the termination of a Participation instance that was created in error.
`Pending` The state representing that fact that the Participation has not yet become active.
`root`

Field Summary
`static UID`	`CODE_SYSTEM`
`static ST`	`CODE_SYSTEM_NAME`

Method Summary
`ST`	`code()` The plain code symbol defined by the code system.
`UID`	`codeSystem()` Specifies the code system that defines the code.
`ST`	`codeSystemName()` A common name of the coding system.
`ST`	`codeSystemVersion()` If applicable, a version descriptor defined specifically for the given code system.
`ST`	`displayName()` A name or title for the code, under which the sending system shows the code value to its users.
`java.lang.String`	`domainName()`
`BL`	`equal(ANY that)`
`BL`	`implies(CD that)`
`BL`	`isNull()`
`boolean`	`isNullJ()`
`ManagedParticipationStatus`	`mostSpecificGeneralization(CD that)`
`BL`	`nonNull()`
`boolean`	`nonNullJ()`
`BL`	`notApplicable()`
`boolean`	`notApplicableJ()`
`NullFlavor`	`nullFlavor()` An exceptional value expressing missing information and possibly the reason why the information is missing.
`ST`	`originalText()`
`BL`	`other()`
`boolean`	`otherJ()`
`LIST<CR>`	`qualifier()`
`java.lang.String`	`toString()`
`SET<CD>`	`translation()`
`BL`	`unknown()`
`boolean`	`unknownJ()`
`static ManagedParticipationStatus`	`valueOf(ST code)`
`static ManagedParticipationStatus`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ManagedParticipationStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

root

public static final ManagedParticipationStatus root

Normal

public static final ManagedParticipationStatus Normal

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

Active

public static final ManagedParticipationStatus Active

The state representing the fact that the Participation is in progress.

Cancelled

public static final ManagedParticipationStatus Cancelled

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

Completed

public static final ManagedParticipationStatus Completed

The terminal state representing the successful completion of the Participation.

Pending

public static final ManagedParticipationStatus Pending

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

Nullified

public static final ManagedParticipationStatus Nullified

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

Field Detail

CODE_SYSTEM

public static final UID CODE_SYSTEM

CODE_SYSTEM_NAME

public static final ST CODE_SYSTEM_NAME

Method Detail

values

public static final ManagedParticipationStatus[] values()

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

for(ManagedParticipationStatus c : ManagedParticipationStatus.values())
        System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they're declared

valueOf

public static ManagedParticipationStatus valueOf(java.lang.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:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

equal

public final BL equal(ANY that)

Specified by:: equal in interface ANY

implies

public BL implies(CD that)

Specified by:: implies in interface CD

mostSpecificGeneralization

public ManagedParticipationStatus mostSpecificGeneralization(CD that)

Specified by:: mostSpecificGeneralization in interface CD

valueOf

public static ManagedParticipationStatus valueOf(ST code)

toString

public java.lang.String toString()

Specified by:: toString in interface CS
Overrides:: toString in class java.lang.Enum<ManagedParticipationStatus>