Package org.projecthusky.common.basetypes

Class IdentificatorBaseType

java.lang.Object
org.projecthusky.common.basetypes.IdentificatorBaseType
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Identificator
public class IdentificatorBaseType extends Object implements Serializable
An identifier that uniquely identifies a thing or object. Examples are object identifier for HL7 RIM objects, medical record number, order id, service catalog item id, Vehicle Identification Number (VIN), etc. Instance identifiers are defined based on ISO object identifiers.
See Also:

  • Constructor Details

    • IdentificatorBaseType

      public IdentificatorBaseType()
      Instantiates a new IdentificatorBaseType. Default constructor.

  • Method Details

    • builder

      @Generated("SparkTools") public static IdentificatorBaseType.Builder builder()
      Creates builder to build IdentificatorBaseType.
      Returns:
      created builder

    • equals

      public boolean equals(Object obj)
      Checks whether the two objects are equal (based on their content).
      Overrides:
      equals in class Object
      Parameters:
      obj - the IdentificatorBaseType to compare
      Returns:
      true, if equal; false otherwise.

    • getAssigningAuthorityName

      public String getAssigningAuthorityName()
      Gets the assigning authority name.
      Returns:
      the assigning authority name

    • setAssigningAuthorityName

      public void setAssigningAuthorityName(String assigningAuthorityName)
      Sets the assigning authority name. See getter getAssigningAuthorityName() for more details.
      Parameters:
      assigningAuthorityName - the new assigning authority name

    • getExtension

      public String getExtension()
      Gets the extension. A character string as a unique identifier within the scope of the identifier root.
      Returns:
      the extension

    • setExtension

      public void setExtension(String extension)
      Sets the extension. See getter getExtension() for more details.
      Parameters:
      extension - the new extension

    • getNullFlavor

      public NullFlavor getNullFlavor()
      Gets the null flavor.
      Returns:
      the null flavor

    • getRoot

      public String getRoot()
      Gets the OID or UUID of the domain. A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier (e.g. UUID without further definition by the extension).
      Returns:
      the root

    • setRoot

      public void setRoot(String root)
      Sets the root. See getter getRoot() for more details.
      Parameters:
      root - the new root

    • hashCode

      public int hashCode()
      Hash code.
      Overrides:
      hashCode in class Object
      Returns:
      the int

    • isDisplayable

      public Boolean isDisplayable()
      Checks if is displayable. Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
      Returns:
      true, if is displayable

    • isNullFlavor

      public boolean isNullFlavor()
      Checks if the current instance is null flavored.
      Returns:
      true, if is null flavor

    • setNullFlavor

      public void setNullFlavor(NullFlavor nullFlavor)
      Sets the null flavor.
      Parameters:
      nullFlavor - the new null flavor

    • setDisplayable

      public void setDisplayable(Boolean displayable)
      Sets the displayable flag. See getter isDisplayable() for more details.
      Parameters:
      displayable - the new displayable

    • toString

      public String toString()
      Builds a string of the whole identificator.
      Overrides:
      toString in class Object
      Returns:
      the string