java.lang.Object
java.lang.Enum<CollectionStatus>
org.odpi.openmetadata.accessservices.digitalservice.properties.CollectionStatus
All Implemented Interfaces:
Serializable, Comparable<CollectionStatus>, Constable

public enum CollectionStatus extends Enum<CollectionStatus>
CollectionStatus specifies which subset of a collection should be returned. The relationship that links a member into a collection has an start and end date (called the effective dates). The Community Profile OMAS uses the CollectionStatus and the effective dates to determine which members to return.
  • ACTIVE - all the collection members with a current effective dates. This is the default.
  • PAST - all the collection members that have effective dates in the past.
  • FUTURE - all the collection members that become effective in the future.
  • ALL - all the collection members linked to the collection irrespective of their effective dates.
  • Enum Constant Details

    • ACTIVE

      public static final CollectionStatus ACTIVE
      All the collection members with a current effective dates (default).
    • PAST

      public static final CollectionStatus PAST
      All the collection members that have effective dates in the past.
    • FUTURE

      public static final CollectionStatus FUTURE
      All the collection members that become effective in the future.
    • ALL

      public static final CollectionStatus ALL
      All the collection members linked to the collection irrespective of their effective dates.
  • Method Details

    • values

      public static CollectionStatus[] 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 CollectionStatus 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 numeric representation of the enumeration.
      Returns:
      int ordinal
    • getName

      public String getName()
      Return the default name of the enumeration.
      Returns:
      String name
    • getDescription

      public String getDescription()
      Return the default description of the enumeration.
      Returns:
      String description
    • toString

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