ca.infoway.messagebuilder.xml
Class ConformanceLevel

Package class diagram package ConformanceLevel
java.lang.Object
  extended by ca.infoway.messagebuilder.lang.Enum
      extended by ca.infoway.messagebuilder.lang.EnumPattern
          extended by ca.infoway.messagebuilder.xml.ConformanceLevel
All Implemented Interfaces:
Serializable, Comparable

public class ConformanceLevel
extends EnumPattern

Conformance level.

This enum models the various conformance levels in the HL7 standards materials.

Author:
Intelliware Development
See Also:
Serialized Form

Field Summary
static ConformanceLevel IGNORED
          The ignored conformance level.
static ConformanceLevel MANDATORY
          The mandatory conformance level.
static ConformanceLevel NOT_ALLOWED
          The not allowed conformance level.
static ConformanceLevel OPTIONAL
          The optional conformance level.
static ConformanceLevel POPULATED
          The populated conformance level.
static ConformanceLevel REQUIRED
          The requied conformance level.
 
Fields inherited from class ca.infoway.messagebuilder.lang.Enum
INNER_CLASS_SEPARATOR_CHAR, iToString, PACKAGE_SEPARATOR_CHAR
 
Method Summary
 String getDescription()
          Gets a human-readable description of the conformance level.
 boolean isMorePermissive(ConformanceLevel conformanceLevel)
          A convenience method to see if one conformance level is more permissive than another conformance level.
 
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

MANDATORY

public static final ConformanceLevel MANDATORY

The mandatory conformance level. A mandatory data element must exist in the HL7 message and must have a non-null value.


POPULATED

public static final ConformanceLevel POPULATED

The populated conformance level. A populated data element must exist in the HL7 message, but may have a null flavor associated with it.


REQUIRED

public static final ConformanceLevel REQUIRED

The requied conformance level. This term is prone to misunderstanding, becase in terms of the data in the message, required elements are closest to optional elements. What distinguishes the required conformance level from the optional conformance level is that a compliant system should save, persist or process any data values provided.


OPTIONAL

public static final ConformanceLevel OPTIONAL

The optional conformance level. An optional data element might or might not exist in the HL7 message. Null flavors are also possible.


IGNORED

public static final ConformanceLevel IGNORED

The ignored conformance level.


NOT_ALLOWED

public static final ConformanceLevel NOT_ALLOWED

The not allowed conformance level.

Method Detail

getDescription

public String getDescription()

Gets a human-readable description of the conformance level.

Returns:
the description

isMorePermissive

public boolean isMorePermissive(ConformanceLevel conformanceLevel)

A convenience method to see if one conformance level is more permissive than another conformance level.

Parameters:
conformanceLevel - - the other conformance level.
Returns:
true if the conformance level is more permissive than the parameter value.


Copyright © 2013. All Rights Reserved.