org.odpi.openmetadata.accessservices.assetconsumer.properties

Enum AssetCollectionStatus

java.lang.Object

java.lang.Enum<AssetCollectionStatus>

org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetCollectionStatus

All Implemented Interfaces:

Serializable, Comparable<AssetCollectionStatus>

public enum AssetCollectionStatus
extends Enum<AssetCollectionStatus>
implements Serializable

AssetCollectionStatus specifies which subset of an asset collection should be returned. The relationship that links an asset into an asset collection has an start and end date (called the effective dates). The Asset Consumer OMAS uses the AssetCollectionStatus and the effective dates to determine which assets to return.

• ACTIVE - All of the assets with a current effective dates
• PAST - All of the assets that have effective dates in the past.
• FUTURE - All of the assets that become effective in the future.
• ALL - All of the assets linked to the collection irrespective of their effective dates.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE
ALL
FUTURE
PAST

Method Summary

Modifier and Type	Method and 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 AssetCollectionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static AssetCollectionStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final AssetCollectionStatus ACTIVE

PAST

public static final AssetCollectionStatus PAST

FUTURE

public static final AssetCollectionStatus FUTURE

ALL

public static final AssetCollectionStatus ALL

Method Detail

values

public static AssetCollectionStatus[] 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 (AssetCollectionStatus c : AssetCollectionStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AssetCollectionStatus 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

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<AssetCollectionStatus>

Returns:

string description