Package com.flowable.engage.message.api

Enum Class Category

java.lang.Object

java.lang.Enum<Category>

com.flowable.engage.message.api.Category

All Implemented Interfaces:

NamedType, Serializable, Comparable<Category>, Constable

public enum Category
extends Enum<Category>
implements NamedType

The enumeration of message categories. The type and subtype describe the data in more detail and are fully customizable, the category, however, is not extensible and defaults to message and event only as of now.

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
ACTION	An action is a specific message sent / received as part of a conversation to interact with the underlying work item or as a generally available action.
EVENT	An event is a data object within the event stream or audit trail.
MEDIA	A media object contains a file and meta information along with an optional message.
MESSAGE	A general message within a conversation.

Method Summary

Modifier and Type	Method	Description
static Category	fromName(String name)
String	getName()	Returns the name of the underlying type, enumeration or category.
String	toString()
static Category	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Category[]	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

MESSAGE

public static final Category MESSAGE

A general message within a conversation.

MEDIA

public static final Category MEDIA

A media object contains a file and meta information along with an optional message.

EVENT

public static final Category EVENT

An event is a data object within the event stream or audit trail.

ACTION

public static final Category ACTION

An action is a specific message sent / received as part of a conversation to interact with the underlying work item or as a generally available action.

Method Details

values

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

getName

public String getName()

Description copied from interface: NamedType

Returns the name of the underlying type, enumeration or category.

Specified by:

getName in interface NamedType

Returns:

the name

fromName

public static Category fromName(String name)

toString

public String toString()

Overrides:

toString in class Enum<Category>