Enum IdentifierUse.ValueSet

    • Enum Constant Detail

      • USUAL

        public static final IdentifierUse.ValueSet USUAL
        Usual

        The identifier recommended for display and use in real-world interactions.

      • OFFICIAL

        public static final IdentifierUse.ValueSet OFFICIAL
        Official

        The identifier considered to be most trusted for the identification of this item. Sometimes also known as "primary" and "main". The determination of "official" is subjective and implementation guides often provide additional guidelines for use.

      • SECONDARY

        public static final IdentifierUse.ValueSet SECONDARY
        Secondary

        An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context.

      • OLD

        public static final IdentifierUse.ValueSet OLD
        Old

        The identifier id no longer considered valid, but may be relevant for search purposes. E.g. Changes to identifier schemes, account merges, etc.

    • Method Detail

      • values

        public static IdentifierUse.ValueSet[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (IdentifierUse.ValueSet c : IdentifierUse.ValueSet.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static IdentifierUse.ValueSet valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()
        Returns:
        The java.lang.String value of the code represented by this enum
      • from

        public static IdentifierUse.ValueSet from​(String value)
        Factory method for creating IdentifierUse.ValueSet values from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value