Package org.projecthusky.common.enums

Enum Class NameUse

java.lang.Object
java.lang.Enum<NameUse>
org.projecthusky.common.enums.NameUse
All Implemented Interfaces:
Serializable, Comparable<NameUse>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
public enum NameUse extends Enum<NameUse> implements ValueSetEnumInterface
Enum NameUse.
Enum NameUse.
Enum NameUse.

  • Enum Constant Details

    • ASSIGNED

      public static final NameUse ASSIGNED
      eCH-0011 V8.1 nameData: Other official person's family name

    • PSEUDONYM

      public static final NameUse PSEUDONYM
      eCH-0011 V8.1 nameData: The person's pseudonym name

  • Field Details

  • Method Details

    • values

      public static NameUse[] 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 NameUse 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 NameUse 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 @NonNull 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.