Package org.projecthusky.common.ch.enums.stable

Enum Class ConfidentialityCode

java.lang.Object
java.lang.Enum<ConfidentialityCode>
org.projecthusky.common.ch.enums.stable.ConfidentialityCode
All Implemented Interfaces:
Serializable, Comparable<ConfidentialityCode>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2025-03-03") public enum ConfidentialityCode extends Enum<ConfidentialityCode> implements ValueSetEnumInterface
Enumeration of DocumentEntry.confidentialityCode values

EN: Document confidentiality as per Annex; EPRO-FDHA.
DE: Vertraulichkeitsstufe gemäss Anhang 3 EPDV-EDI.
FR: Niveau de confidentialité selon l'annexe 3 ODEP-DFI.
IT: Grado di riservatezza secondo l'allegato 3 OCIP-DFI.

Identifier: 2.16.756.5.30.1.127.3.10.1.5
Effective date: 2022-06-26 13:35
Version: 202306.0-stable
Status: FINAL

  • Enum Constant Details

    • NORMAL

      public static final ConfidentialityCode NORMAL
      EN: Normal.
      DE: Normal.
      FR: normal.
      IT: normale.

    • RESTRICTED

      public static final ConfidentialityCode RESTRICTED
      EN: Restricted.
      DE: Eingeschränkt.
      FR: restreint.
      IT: limitato.

    • SECRET

      public static final ConfidentialityCode SECRET
      EN: Secret.
      DE: Geheim.
      FR: secret.
      IT: segreto.

  • Field Details

    • NORMAL_CODE

      public static final String NORMAL_CODE
      EN: Code for Normal.
      DE: Code für Normal.
      FR: Code de normal.
      IT: Code per normale.
      See Also:

    • RESTRICTED_CODE

      public static final String RESTRICTED_CODE
      EN: Code for Restricted.
      DE: Code für Eingeschränkt.
      FR: Code de restreint.
      IT: Code per limitato.
      See Also:

    • SECRET_CODE

      public static final String SECRET_CODE
      EN: Code for Secret.
      DE: Code für Geheim.
      FR: Code de secret.
      IT: Code per segreto.
      See Also:

    • VALUE_SET_ID

      public static final String VALUE_SET_ID
      Identifier of the value set.
      See Also:

    • VALUE_SET_NAME

      public static final String VALUE_SET_NAME
      Name of the value set.
      See Also:

  • Method Details

    • values

      public static ConfidentialityCode[] 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 ConfidentialityCode 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 @Nullable ConfidentialityCode getEnum(@Nullable String code)
      Gets the Enum with a given code.
      Parameters:
      code - The code value.
      Returns:
      the enum value found or null.

    • isEnumOfValueSet

      public static boolean isEnumOfValueSet(@Nullable String enumName)
      Checks if a given enum is part of this value set.
      Parameters:
      enumName - The name of the enum.
      Returns:
      true if the name is found in this value set, false otherwise.

    • isInValueSet

      public static boolean isInValueSet(@Nullable String codeValue)
      Checks if a given code value is in this value set.
      Parameters:
      codeValue - The code value.
      Returns:
      true if the value is found in this value set, false otherwise.

    • getCodeSystemId

      public @NonNull String getCodeSystemId()
      Gets the code system identifier.
      Specified by:
      getCodeSystemId in interface ValueSetEnumInterface
      Returns:
      the code system identifier.

    • getCodeSystemName

      public @NonNull String getCodeSystemName()
      Gets the code system name.
      Specified by:
      getCodeSystemName in interface ValueSetEnumInterface
      Returns:
      the code system name.

    • getCodeValue

      public @NonNull String getCodeValue()
      Gets the code value as a string.
      Specified by:
      getCodeValue in interface ValueSetEnumInterface
      Returns:
      the code value.

    • getDisplayName

      public @NonNull String getDisplayName(@Nullable LanguageCode languageCode)
      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()
      Gets the value set identifier.
      Specified by:
      getValueSetId in interface ValueSetEnumInterface
      Returns:
      the value set identifier.

    • getValueSetName

      public @NonNull String getValueSetName()
      Gets the value set name.
      Specified by:
      getValueSetName in interface ValueSetEnumInterface
      Returns:
      the value set name.