Package org.odpi.openmetadata.metadatasecurity.properties

Enum Class ReferenceableStatus

java.lang.Object
java.lang.Enum<ReferenceableStatus>
org.odpi.openmetadata.metadatasecurity.properties.ReferenceableStatus
All Implemented Interfaces:
Serializable, Comparable<ReferenceableStatus>, Constable
public enum ReferenceableStatus extends Enum<ReferenceableStatus>
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.

  • Enum Constant Details

    • UNKNOWN

      public static final ReferenceableStatus UNKNOWN
      Unknown instance status.

    • DRAFT

      public static final ReferenceableStatus DRAFT
      The content is incomplete.

    • PREPARED

      public static final ReferenceableStatus PREPARED
      The content is ready for review.

    • PROPOSED

      public static final ReferenceableStatus PROPOSED
      The content is in review.

    • APPROVED

      public static final ReferenceableStatus APPROVED
      The content is approved.

    • REJECTED

      public static final ReferenceableStatus REJECTED
      The request or proposal is rejected.

    • APPROVED_CONCEPT

      public static final ReferenceableStatus APPROVED_CONCEPT
      The request or proposal is approved for development.

    • UNDER_DEVELOPMENT

      public static final ReferenceableStatus UNDER_DEVELOPMENT
      The instance is being developed.

    • DEVELOPMENT_COMPLETE

      public static final ReferenceableStatus DEVELOPMENT_COMPLETE
      The development of the instance is complete.

    • APPROVED_FOR_DEPLOYMENT

      public static final ReferenceableStatus APPROVED_FOR_DEPLOYMENT
      The instance is approved for deployment.

    • STANDBY

      public static final ReferenceableStatus STANDBY
      The instance is deployed in standby mode.

    • ACTIVE

      public static final ReferenceableStatus ACTIVE
      The instance is approved and in use.

    • FAILED

      public static final ReferenceableStatus FAILED
      The instance is not in use due to failure.

    • DISABLED

      public static final ReferenceableStatus DISABLED
      The instance is shutdown or disabled.

    • COMPLETE

      public static final ReferenceableStatus COMPLETE
      The activity associated with the instance is complete.

    • DEPRECATED

      public static final ReferenceableStatus DEPRECATED
      The instance is out of date and should not be used.

    • OTHER

      public static final ReferenceableStatus OTHER
      The instance is in a locally defined state.

    • DELETED

      public static final ReferenceableStatus DELETED
      The instance has been deleted and is no longer available.

  • Method Details

    • values

      public static ReferenceableStatus[] 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 ReferenceableStatus 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

    • 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 String getName()
      Return the descriptive name for the enum.
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the description for the enum.
      Returns:
      String description

    • toString

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