Package org.flowable.idm.api.event
Enum FlowableIdmEventType
- java.lang.Object
-
- java.lang.Enum<FlowableIdmEventType>
-
- org.flowable.idm.api.event.FlowableIdmEventType
-
- All Implemented Interfaces:
Serializable,Comparable<FlowableIdmEventType>,FlowableEventType
public enum FlowableIdmEventType extends Enum<FlowableIdmEventType> implements FlowableEventType
Enumeration containing all possible types of Flowable IDM events.- Author:
- Frederik Heremans
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CUSTOMAn event type to be used by custom events.ENGINE_CLOSEDThe process-engine that dispatched this event has been closed and cannot be used anymore.ENGINE_CREATEDThe process-engine that dispatched this event has been created and is ready for use.ENTITY_CREATEDNew entity is created.ENTITY_DELETEDExisting entity is deleted.ENTITY_INITIALIZEDNew entity has been created and all child-entities that are created as a result of the creation of this particular entity are also created and initialized.ENTITY_UPDATEDExisting entity us updated.MEMBERSHIP_CREATEDA new membership has been created.MEMBERSHIP_DELETEDA single membership has been deleted.MEMBERSHIPS_DELETEDAll memberships in the related group have been deleted.
-
Field Summary
Fields Modifier and Type Field Description static FlowableIdmEventType[]EMPTY_ARRAY
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FlowableIdmEventType[]getTypesFromString(String string)static FlowableIdmEventTypevalueOf(String name)Returns the enum constant of this type with the specified name.static FlowableIdmEventType[]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, toString, valueOf
-
Methods inherited from interface org.flowable.common.engine.api.delegate.event.FlowableEventType
name
-
-
-
-
Enum Constant Detail
-
ENTITY_CREATED
public static final FlowableIdmEventType ENTITY_CREATED
New entity is created.
-
ENTITY_INITIALIZED
public static final FlowableIdmEventType ENTITY_INITIALIZED
New entity has been created and all child-entities that are created as a result of the creation of this particular entity are also created and initialized.
-
ENTITY_UPDATED
public static final FlowableIdmEventType ENTITY_UPDATED
Existing entity us updated.
-
ENTITY_DELETED
public static final FlowableIdmEventType ENTITY_DELETED
Existing entity is deleted.
-
CUSTOM
public static final FlowableIdmEventType CUSTOM
An event type to be used by custom events. These types of events are never thrown by the engine itself, only be an external API call to dispatch an event.
-
ENGINE_CREATED
public static final FlowableIdmEventType ENGINE_CREATED
The process-engine that dispatched this event has been created and is ready for use.
-
ENGINE_CLOSED
public static final FlowableIdmEventType ENGINE_CLOSED
The process-engine that dispatched this event has been closed and cannot be used anymore.
-
MEMBERSHIP_CREATED
public static final FlowableIdmEventType MEMBERSHIP_CREATED
A new membership has been created.
-
MEMBERSHIP_DELETED
public static final FlowableIdmEventType MEMBERSHIP_DELETED
A single membership has been deleted.
-
MEMBERSHIPS_DELETED
public static final FlowableIdmEventType MEMBERSHIPS_DELETED
All memberships in the related group have been deleted. No individualMEMBERSHIP_DELETEDevents will be dispatched due to possible performance reasons. The event is dispatched before the memberships are deleted, so they can still be accessed in the dispatch method of the listener.
-
-
Field Detail
-
EMPTY_ARRAY
public static final FlowableIdmEventType[] EMPTY_ARRAY
-
-
Method Detail
-
values
public static FlowableIdmEventType[] 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 (FlowableIdmEventType c : FlowableIdmEventType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FlowableIdmEventType 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 nameNullPointerException- if the argument is null
-
getTypesFromString
public static FlowableIdmEventType[] getTypesFromString(String string)
- Parameters:
string- the string containing a comma-separated list of event-type names- Returns:
- a list of
FlowableIdmEventTypebased on the given list. - Throws:
IllegalArgumentException- when one of the given string is not a valid type name
-
-