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

Enum Class CollectionMemberStatus

java.lang.Object

java.lang.Enum<CollectionMemberStatus>

org.odpi.openmetadata.accessservices.communityprofile.properties.CollectionMemberStatus

All Implemented Interfaces:

Serializable, Comparable<CollectionMemberStatus>, Constable

public enum CollectionMemberStatus
extends Enum<CollectionMemberStatus>
implements Serializable

CollectionMemberStatus specifies the the status of the member in a collection.

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
DEPRECATED	The membership has been deprecated.
DISCOVERED	The member was added by a discovery process.
IMPORTED	The member was imported from another system.
OBSOLETE	The membership is obsolete and should not be used.
OTHER	The membership has a different status not covered by the open metadata types.
PROPOSED	The member was proposed by a consumer.
UNKNOWN	The status of the member is not known or not specified.
VALIDATED	The member has been validated by a custodian/steward/approver and can be trusted.

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.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	toString()	toString() JSON-style
static CollectionMemberStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionMemberStatus[]	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

UNKNOWN

public static final CollectionMemberStatus UNKNOWN

The status of the member is not known or not specified. This is the default value.

DISCOVERED

public static final CollectionMemberStatus DISCOVERED

The member was added by a discovery process.

PROPOSED

public static final CollectionMemberStatus PROPOSED

The member was proposed by a consumer.

IMPORTED

public static final CollectionMemberStatus IMPORTED

The member was imported from another system.

VALIDATED

public static final CollectionMemberStatus VALIDATED

The member has been validated by a custodian/steward/approver and can be trusted.

DEPRECATED

public static final CollectionMemberStatus DEPRECATED

The membership has been deprecated. Consider stopping using it.

OBSOLETE

public static final CollectionMemberStatus OBSOLETE

The membership is obsolete and should not be used.

OTHER

public static final CollectionMemberStatus OTHER

The membership has a different status not covered by the open metadata types.

Method Details

values

public static CollectionMemberStatus[] 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 CollectionMemberStatus 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

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int code number

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<CollectionMemberStatus>

Returns:

string description