Package org.odpi.openmetadata.accessservices.communityprofile.properties

Enum CollectionStatus

  • All Implemented Interfaces:
    Serializable, Comparable<CollectionStatus>
    public enum CollectionStatus
extends Enum<CollectionStatus>
implements Serializable
    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 of the collection members with a current effective dates. This is the default.
    • PAST - All of the collection members that have effective dates in the past.
    • FUTURE - All of the collection members that become effective in the future.
    • ALL - All of the collection members linked to the collection irrespective of their effective dates.

    • Method Detail

      • values

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

      • valueOf

        public static CollectionStatus valueOf​(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:
        IllegalArgumentException - if this enum type 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