Package org.projecthusky.common.at.enums

Enum Class DocumentLanguage

java.lang.Object

java.lang.Enum<DocumentLanguage>

org.projecthusky.common.at.enums.DocumentLanguage

All Implemented Interfaces:

Serializable, Comparable<DocumentLanguage>, Constable, ValueSetEnumInterfaceAt, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface

public enum DocumentLanguage
extends Enum<DocumentLanguage>
implements ValueSetEnumInterfaceAt

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
GERMAN

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VALUE_SET_ID	Identifier of the value set
static final String	VALUE_SET_NAME	Name of the value set

Method Summary

Modifier and Type	Method	Description
String	getCodeSystemId()	Gets the code system identifier.
String	getCodeSystemName()	Gets the code system name.
String	getCodeValue()	Gets the actual Code as string
String	getDisplayNameAt(LanguageCode languageCode)	Gets the display name defined by the language param.
static DocumentLanguage	getEnum(String code)	Gets the Enum with a given code
String	getValueSetId()	Gets the value set identifier.
String	getValueSetName()	Gets the value set name.
static boolean	isEnumOfValueSet(String enumName)	Checks if a given enum is part of this value set.
static boolean	isInValueSet(String codeValue)	Checks if a given code value is in this value set.
static DocumentLanguage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentLanguage[]	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

Methods inherited from interface org.projecthusky.common.enums.ValueSetEnumInterface

getCD, getCD, getCE, getCE, getCode, getCode, getCodedString, getIpfCode, isContainedIn, isEqualTo, name

Methods inherited from interface org.projecthusky.common.at.enums.ValueSetEnumInterfaceAt

getDisplayName, getDisplayName, getHl7cdar2CE

Enum Constant Details

GERMAN

public static final DocumentLanguage GERMAN

Field Details

VALUE_SET_ID

public static final String VALUE_SET_ID

Identifier of the value set

See Also:

• Constant Field Values

VALUE_SET_NAME

public static final String VALUE_SET_NAME

Name of the value set

See Also:

• Constant Field Values

Method Details

values

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

getEnum

public static DocumentLanguage getEnum(String code)

Gets the Enum with a given code

Parameters:

code -

Returns:

the enum

isEnumOfValueSet

public static boolean isEnumOfValueSet(String enumName)

Checks if a given enum is part of this value set.

Parameters:

enumName -

Returns:

true, if enum is in this value set

isInValueSet

public static boolean isInValueSet(String codeValue)

Checks if a given code value is in this value set.

Parameters:

codeValue -

Returns:

true, if is in value set

getCodeSystemId

public String getCodeSystemId()

Gets the code system identifier.

Specified by:

getCodeSystemId in interface ValueSetEnumInterface

Returns:

the code system identifier

getCodeSystemName

public String getCodeSystemName()

Gets the code system name.

Specified by:

getCodeSystemName in interface ValueSetEnumInterface

Returns:

the code system identifier

getCodeValue

public String getCodeValue()

Gets the actual Code as string

Specified by:

getCodeValue in interface ValueSetEnumInterface

Returns:

the code

getDisplayNameAt

public String getDisplayNameAt(LanguageCode languageCode)

Gets the display name defined by the language param. If there is no english translation, the default display name is returned.

Specified by:

getDisplayNameAt in interface ValueSetEnumInterfaceAt

Parameters:

languageCode - the language code to get the display name for

Returns:

returns the display name in the desired language. if language not found, display name in german will returned

getValueSetId

public String getValueSetId()

Gets the value set identifier.

Specified by:

getValueSetId in interface ValueSetEnumInterface

Returns:

the value set identifier

getValueSetName

public String getValueSetName()

Gets the value set name.

Specified by:

getValueSetName in interface ValueSetEnumInterface

Returns:

the value set name