EventCode (Clinical Document Library 2.0.2 API)

java.lang.Object
- java.lang.Enum<EventCode>
- - au.gov.nehta.model.cda.common.time.EventCode

All Implemented Interfaces:: Serializable, Comparable<EventCode>

public enum EventCode
extends Enum<EventCode>

EventCode

Created to model the CDA Event codes for time.

 AC before meal  (from lat. ante cibus)
 ACM before breakfast   (from lat. ante cibus matutinus)
 ACD before lunch (from lat. ante cibus diurnus)
 ACV before dinner  (from lat. ante cibus vespertinus)
 HS hour of sleep
 IC between meals  (from lat. inter cibus)
 ICM between breakfast and lunch
 ICD between lunch and dinner
 ICV between dinner and the hour of sleep
 PC after meals  (from lat. post cibus)
 PCM after breakfast   (from lat. post cibus matutinus)
 PCD after lunch   (from lat. post cibus diurnus)
 PCV after dinner  (from lat. post cibus vespertinus)

Author:: NeHTA

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AFTER_BREAKFAST`
`AFTER_DINNER`
`AFTER_LUNCH`
`AFTER_MEALS`
`BEFORE_BREAKFST`
`BEFORE_DINNER`
`BEFORE_LUNCH`
`BEFORE_MEAL`
`BETWEEN_BREAKFAST_AND_LUNCH`
`BETWEEN_DINNER_AND_HOUR_OF_SLEEP`
`BETWEEN_LUNCH_AND_DINNER`
`BETWEEN_MEAL`
`HOUR_OF_SLEEP`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCode()`
`static EventCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EventCode[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - BEFORE_MEAL
```
public static final EventCode BEFORE_MEAL
```
  - BEFORE_BREAKFST
```
public static final EventCode BEFORE_BREAKFST
```
  - BEFORE_LUNCH
```
public static final EventCode BEFORE_LUNCH
```
  - BEFORE_DINNER
```
public static final EventCode BEFORE_DINNER
```
  - HOUR_OF_SLEEP
```
public static final EventCode HOUR_OF_SLEEP
```
  - BETWEEN_MEAL
```
public static final EventCode BETWEEN_MEAL
```
  - BETWEEN_BREAKFAST_AND_LUNCH
```
public static final EventCode BETWEEN_BREAKFAST_AND_LUNCH
```
  - BETWEEN_LUNCH_AND_DINNER
```
public static final EventCode BETWEEN_LUNCH_AND_DINNER
```
  - BETWEEN_DINNER_AND_HOUR_OF_SLEEP
```
public static final EventCode BETWEEN_DINNER_AND_HOUR_OF_SLEEP
```
  - AFTER_MEALS
```
public static final EventCode AFTER_MEALS
```
  - AFTER_BREAKFAST
```
public static final EventCode AFTER_BREAKFAST
```
  - AFTER_LUNCH
```
public static final EventCode AFTER_LUNCH
```
  - AFTER_DINNER
```
public static final EventCode AFTER_DINNER
```
- Method Detail
  - values
```
public static EventCode[] 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 (EventCode c : EventCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EventCode 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
  - getCode
```
public String getCode()
```

Enum EventCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BEFORE_MEAL

BEFORE_BREAKFST

BEFORE_LUNCH

BEFORE_DINNER

HOUR_OF_SLEEP

BETWEEN_MEAL

BETWEEN_BREAKFAST_AND_LUNCH

BETWEEN_LUNCH_AND_DINNER

BETWEEN_DINNER_AND_HOUR_OF_SLEEP

AFTER_MEALS

AFTER_BREAKFAST

AFTER_LUNCH

AFTER_DINNER

Method Detail

values

valueOf

getCode