Enum ReferenceableStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ReferenceableStatus>

    public enum ReferenceableStatus
    extends java.lang.Enum<ReferenceableStatus>
    implements java.io.Serializable
    The ReferenceableStatus enum defines the status of an instance (classification, relationship or an entity) in the metadata collection. It effectively defines its visibility to different types of queries. Most queries by default will only return instances in the active status.
    • Unknown: Unknown instance status.
    • Draft: The content is incomplete.
    • Proposed: The content is in review.
    • Approved: The content is approved.
    • Rejected: The request or proposal is rejected.
    • Approved concept: The request or proposal is approved for development.
    • Under development: The instance is being developed.
    • Development complete: The development of the instance is complete.
    • Approved for deployment: The instance is approved for deployment.
    • StandBy: The instance is deployed in standby mode.
    • Active: The instance is approved and in use.
    • Failed: The instance is not in use due to failure.
    • Disabled: The instance is shutdown or disabled.
    • Complete: The activity associated with the instance is complete.
    • Deprecated: The instance is out of date and should not be used.
    • Other: The instance is in a locally defined state.
    • Deleted: The instance has been deleted and is waiting to be purged. It is kept in the metadata collection to support a restore request. It is not returned on normal queries.
    • Method Detail

      • values

        public static ReferenceableStatus[] 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 (ReferenceableStatus c : ReferenceableStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ReferenceableStatus valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getOrdinal

        public int getOrdinal()
        Return the numerical value for the enum.
        Returns:
        int enum value ordinal
      • getOMRSOrdinal

        public int getOMRSOrdinal()
        Return the ordinal for the equivalent OMRS status. This helps convert between an OMRS entity and the security bean.
        Returns:
        int enum value ordinal from OMRS
      • getName

        public java.lang.String getName()
        Return the descriptive name for the enum.
        Returns:
        String name
      • getDescription

        public java.lang.String getDescription()
        Return the description for the enum.
        Returns:
        String description
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<ReferenceableStatus>
        Returns:
        string description