org.ow2.bonita.facade.def.element
Enum HookDefinition.Event

java.lang.Object
  java.lang.Enum<HookDefinition.Event>
      org.ow2.bonita.facade.def.element.HookDefinition.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HookDefinition.Event>

Enclosing interface:

HookDefinition

public static enum HookDefinition.Event
extends java.lang.Enum<HookDefinition.Event>

A Hook Event is used to define when a connector will be executed.

Enum Constant Summary

automaticOnEnter

automaticOnExit

instanceOnAbort

instanceOnCancel

instanceOnFinish

instanceOnStart

onEvent

onTimer

taskOnCancel

taskOnFinish

taskOnReady

taskOnResume

taskOnStart

taskOnSuspend

Field Summary

static java.util.List<HookDefinition.Event>	PROCESS_EVENTS This list contains all the process events.
static java.util.List<HookDefinition.Event>	TASK_EVENTS This list contains all the task (human activity) events.

Method Summary

java.lang.String	format() Formats the event name i.e.
static HookDefinition.Event	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HookDefinition.Event[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

taskOnReady

public static final HookDefinition.Event taskOnReady

taskOnStart

public static final HookDefinition.Event taskOnStart

taskOnFinish

public static final HookDefinition.Event taskOnFinish

taskOnSuspend

public static final HookDefinition.Event taskOnSuspend

taskOnResume

public static final HookDefinition.Event taskOnResume

taskOnCancel

public static final HookDefinition.Event taskOnCancel

automaticOnEnter

public static final HookDefinition.Event automaticOnEnter

automaticOnExit

public static final HookDefinition.Event automaticOnExit

onTimer

public static final HookDefinition.Event onTimer

instanceOnStart

public static final HookDefinition.Event instanceOnStart

instanceOnFinish

public static final HookDefinition.Event instanceOnFinish

instanceOnCancel

public static final HookDefinition.Event instanceOnCancel

instanceOnAbort

public static final HookDefinition.Event instanceOnAbort

onEvent

public static final HookDefinition.Event onEvent

Field Detail

TASK_EVENTS

public static final java.util.List<HookDefinition.Event> TASK_EVENTS

This list contains all the task (human activity) events.

PROCESS_EVENTS

public static final java.util.List<HookDefinition.Event> PROCESS_EVENTS

This list contains all the process events.

Method Detail

values

public static final HookDefinition.Event[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(HookDefinition.Event c : HookDefinition.Event.values())
        System.out.println(c);

Returns:

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

valueOf

public static HookDefinition.Event valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

format

public java.lang.String format()

Formats the event name i.e. taskOnReady becomes task:onReady, automaticOnEnter becomes automatic:onEnter, ...

Returns:

the formatted event name