Enum Class Status
- All Implemented Interfaces:
Serializable
,Comparable<Status>
,Constable
The Status defines the status of a relationship or an entity in the glossary. It effectively
defines its visibility to different types of queries. Most queries by default will only return instances in the
active status.
- UNKNOWN Unknown status of instance.
- DRAFT The content is incomplete.
- PREPARED The content is ready for review.
- PROPOSED The content is in review.
- APPROVED Instance approved.
- ACTIVE: the instance is in active use.
- 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe instance is in useThe content has been approved.Instance that has been deleted and is no longer in use.The content incomplete and not ready for review.The content is ready for review.The content is in reviewUnknown status of instance -
Method Summary
Modifier and TypeMethodDescriptionint
Return the numerical value for the enum.Return the description for the enum.Return the descriptive name for the enum.static Status
Returns the enum constant of this class with the specified name.static Status[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
Unknown status of instance -
DRAFT
The content incomplete and not ready for review. -
PREPARED
The content is ready for review. -
PROPOSED
The content is in review -
APPROVED
The content has been approved. -
ACTIVE
The instance is in use -
DELETED
Instance that has been deleted and is no longer in use.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the numerical value for the enum.- Returns:
- int enum value ordinal
-
getStatusName
Return the descriptive name for the enum.- Returns:
- String name
-
getStatusDescription
Return the description for the enum.- Returns:
- String description
-