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

Enum Class CollectionStatus

java.lang.Object

java.lang.Enum<CollectionStatus>

org.odpi.openmetadata.accessservices.communityprofile.properties.CollectionStatus

All Implemented Interfaces:

Serializable, Comparable<CollectionStatus>, Constable

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 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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE
ALL
FUTURE
PAST

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the enumeration.
String	getName()	Return the default name of the enumeration.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	toString()	toString() JSON-style
static CollectionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACTIVE

public static final CollectionStatus ACTIVE

PAST

public static final CollectionStatus PAST

FUTURE

public static final CollectionStatus FUTURE

ALL

public static final CollectionStatus ALL

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