Package org.odpi.openmetadata.accessservices.stewardshipaction.events

Enum Class StewardshipActionEventType

java.lang.Object

java.lang.Enum<StewardshipActionEventType>

org.odpi.openmetadata.accessservices.stewardshipaction.events.StewardshipActionEventType

All Implemented Interfaces:

Serializable, Comparable<StewardshipActionEventType>, Constable

public enum StewardshipActionEventType
extends Enum<StewardshipActionEventType>
implements Serializable

StewardshipActionEventType describes the different types of events produced by the Stewardship Action OMAS. Events are limited to assets that are in the zones listed in the supportedZones property passed to the Stewardship Action OMAS at start up (a null value here means all zones).

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
ELEMENT_CLASSIFIED	A classification has been added to an element.
ELEMENT_DECLASSIFIED	A classification has been removed from an element.
ELEMENT_DELETED	An element and all its anchored elements have been deleted.
ELEMENT_GUID_CHANGED	An element's GUID has changed.
ELEMENT_HOME_CHANGED	An element's home has changed.
ELEMENT_RECLASSIFIED	The properties for a classification attached to an element have been updated.
ELEMENT_RESTORED	An element that was once deleted has been restored.
ELEMENT_TYPE_CHANGED	An element's type has changed.
ELEMENT_UPDATED	An element's properties has been updated.
NEW_ELEMENT_CREATED	A new element has been created.
REFRESH_ELEMENT_EVENT	An element has been distributed around the cohort - could be for the first time.
UNKNOWN_EVENT	An event that is not recognized by the local server.

Method Summary

Modifier and Type	Method	Description
int	getEventTypeCode()	Return the int identifier used for indexing based on the enum.
String	getEventTypeDescription()	Return the default description for the enum value - used when natural resource bundle is not available.
String	getEventTypeName()	Return the string name used for messages that include the enum.
String	toString()	JSON-style toString
static StewardshipActionEventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StewardshipActionEventType[]	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_EVENT

public static final StewardshipActionEventType UNKNOWN_EVENT

An event that is not recognized by the local server.

REFRESH_ELEMENT_EVENT

public static final StewardshipActionEventType REFRESH_ELEMENT_EVENT

An element has been distributed around the cohort - could be for the first time.

NEW_ELEMENT_CREATED

public static final StewardshipActionEventType NEW_ELEMENT_CREATED

A new element has been created.

ELEMENT_UPDATED

public static final StewardshipActionEventType ELEMENT_UPDATED

An element's properties has been updated.

ELEMENT_DELETED

public static final StewardshipActionEventType ELEMENT_DELETED

An element and all its anchored elements have been deleted.

ELEMENT_CLASSIFIED

public static final StewardshipActionEventType ELEMENT_CLASSIFIED

A classification has been added to an element.

ELEMENT_RECLASSIFIED

public static final StewardshipActionEventType ELEMENT_RECLASSIFIED

The properties for a classification attached to an element have been updated.

ELEMENT_DECLASSIFIED

public static final StewardshipActionEventType ELEMENT_DECLASSIFIED

A classification has been removed from an element.

ELEMENT_RESTORED

public static final StewardshipActionEventType ELEMENT_RESTORED

An element that was once deleted has been restored.

ELEMENT_GUID_CHANGED

public static final StewardshipActionEventType ELEMENT_GUID_CHANGED

An element's GUID has changed.

ELEMENT_TYPE_CHANGED

public static final StewardshipActionEventType ELEMENT_TYPE_CHANGED

An element's type has changed.

ELEMENT_HOME_CHANGED

public static final StewardshipActionEventType ELEMENT_HOME_CHANGED

An element's home has changed.

Method Details

values

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

getEventTypeCode

public int getEventTypeCode()

Return the int identifier used for indexing based on the enum.

Returns:

int identifier code

getEventTypeName

public String getEventTypeName()

Return the string name used for messages that include the enum.

Returns:

String name

getEventTypeDescription

public String getEventTypeDescription()

Return the default description for the enum value - used when natural resource bundle is not available.

Returns:

String default description

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<StewardshipActionEventType>

Returns:

return string containing the property names and values