Package org.projecthusky.common.enums

Enum Class NameQualifier

java.lang.Object

java.lang.Enum<NameQualifier>

org.projecthusky.common.enums.NameQualifier

All Implemented Interfaces:

Serializable, Comparable<NameQualifier>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface

public enum NameQualifier
extends Enum<NameQualifier>
implements ValueSetEnumInterface

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
ACADEMIC	Academic title

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE_SYSTEM_NAME	The Constant CODE_SYSTEM_NAME.
static final String	CODE_SYSTEM_OID	The Constant CODE_SYSTEM.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getCodeSystemId()	Gets the code system id. Liefert die code system id.
String	getCodeSystemName()	Gets the code system name. Liefert code system name.
String	getCodeValue()	Gets the actual Code as string Liefert den eigentlichen Code als String
String	getDisplayName()	Gets the display name. Liefert display name.
@NonNull String	getDisplayName(@Nullable LanguageCode languageCode)	Gets the display name defined by the language param.
static NameQualifier	getEnum(String code)	Gets the Enum with a given code Liefert den Enum anhand eines gegebenen codes
@NonNull String	getValueSetId()	Gets the value set identifier.
@NonNull String	getValueSetName()	Gets the value set name.
static boolean	isEnumOfValueSet(String enumName)	Checks if a given enum is part of this value set. Prüft, ob der gegebene enum Teil dieses Value Sets ist.
static boolean	isInValueSet(String codeValue)	Checks if a given code value is in this value set. Prüft, ob der gegebene code in diesem Value Set vorhanden ist.
static NameQualifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NameQualifier[]	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

Enum Constant Details

ACADEMIC

public static final NameQualifier ACADEMIC

Academic title

Field Details

CODE_SYSTEM_NAME

public static final String CODE_SYSTEM_NAME

The Constant CODE_SYSTEM_NAME.

See Also:

• Constant Field Values

CODE_SYSTEM_OID

public static final String CODE_SYSTEM_OID

The Constant CODE_SYSTEM.

See Also:

• Constant Field Values

Method Details

values

public static NameQualifier[] 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 NameQualifier 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 NameQualifier getEnum(String code)

Gets the Enum with a given code

Liefert den Enum anhand eines gegebenen codes

Parameters:

code -

code

Returns:

the enum

isEnumOfValueSet

public static boolean isEnumOfValueSet(String enumName)

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

Prüft, ob der gegebene enum Teil dieses Value Sets ist.

Parameters:

enumName -

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.

Prüft, ob der gegebene code in diesem Value Set vorhanden ist.

Parameters:

codeValue -

code

Returns:

true, if one enum of this valueset contains the given code

getCodeSystemName

public String getCodeSystemName()

Gets the code system name.

Liefert code system name.

Specified by:

getCodeSystemName in interface ValueSetEnumInterface

Returns:

the code system name

getCodeSystemId

public @NonNull String getCodeSystemId()

Gets the code system id.

Liefert die code system id.

Specified by:

getCodeSystemId in interface ValueSetEnumInterface

Returns:

the code system id

getCodeValue

public String getCodeValue()

Gets the actual Code as string

Liefert den eigentlichen Code als String

Specified by:

getCodeValue in interface ValueSetEnumInterface

Returns:

the code

getDisplayName

public String getDisplayName()

Gets the display name.

Liefert display name.

Specified by:

getDisplayName in interface TranslatedEnumInterface

Returns:

the display name

getDisplayName

public @NonNull String getDisplayName(@Nullable LanguageCode languageCode)

Description copied from interface: TranslatedEnumInterface

Gets the display name defined by the language param.

Specified by:

getDisplayName in interface TranslatedEnumInterface

Parameters:

languageCode - The language code to get the display name for, null to get the default display name.

Returns:

the display name in the desired language.

getValueSetId

public @NonNull String getValueSetId()

Description copied from interface: ValueSetEnumInterface

Gets the value set identifier.

Specified by:

getValueSetId in interface ValueSetEnumInterface

Returns:

the value set identifier.

getValueSetName

public @NonNull String getValueSetName()

Description copied from interface: ValueSetEnumInterface

Gets the value set name.

Specified by:

getValueSetName in interface ValueSetEnumInterface

Returns:

the value set name.