Package jadex.bpmn.features

Interface IInternalBpmnComponentFeature

public interface IInternalBpmnComponentFeature

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE_ACTIVITY	Constant for step event.
static java.lang.String	TYPE_THREAD	The change event prefix denoting a thread event.

Method Summary

Modifier and Type	Method	Description
IMonitoringEvent	createActivityEvent(java.lang.String type, ProcessThread thread, MActivity activity)	Create an activity event (start, end).
IMonitoringEvent	createThreadEvent(java.lang.String type, ProcessThread thread)	Create a thread event (creation, modification, termination).
IActivityHandler	getActivityHandler(MActivity activity)	Get the activity handler for an activity.
java.lang.Object	getContextVariable(java.lang.String name)	Get the value of the given context variable.
java.util.List<java.lang.Object>	getMessages()	Get the messages.
java.util.List<IConnection>	getStreams()	Get the streams.
ProcessThread	getTopLevelThread()	Get the top level thread (is not executed and just acts as top level thread container).
boolean	hasContextVariable(java.lang.String name)	Test if the given context variable is declared.
boolean	isFinished()	Check, if the process has terminated.
boolean	isFinished(java.lang.String pool, java.lang.String lane)	Check, if the process has terminated.
boolean	isReady()	Check if the process is ready, i.e.
boolean	isReady(java.lang.String pool, java.lang.String lane)	Check if the process is ready, i.e.
void	notify(MActivity activity, ProcessThread thread, java.lang.Object event)	Method that should be called, when an activity is finished and the following activity should be scheduled.
void	setContextVariable(java.lang.String name, java.lang.Object value)	Set the value of the given context variable.
void	setContextVariable(java.lang.String name, java.lang.Object key, java.lang.Object value)	Set the value of the given context variable.
void	step(MActivity activity, IInternalAccess instance, ProcessThread thread, java.lang.Object event)	Make a process step, i.e.

Field Detail

TYPE_ACTIVITY

static final java.lang.String TYPE_ACTIVITY

Constant for step event.

See Also:

Constant Field Values

TYPE_THREAD

static final java.lang.String TYPE_THREAD

The change event prefix denoting a thread event.

See Also:

Constant Field Values

Method Detail

hasContextVariable

boolean hasContextVariable(java.lang.String name)

Test if the given context variable is declared.

Parameters:

name - The variable name.

Returns:

True, if the variable is declared.

getContextVariable

java.lang.Object getContextVariable(java.lang.String name)

Get the value of the given context variable.

Parameters:

name - The variable name.

Returns:

The variable value.

setContextVariable

void setContextVariable(java.lang.String name,
                        java.lang.Object value)

Set the value of the given context variable.

Parameters:

name - The variable name.

value - The variable value.

setContextVariable

void setContextVariable(java.lang.String name,
                        java.lang.Object key,
                        java.lang.Object value)

Set the value of the given context variable.

Parameters:

name - The variable name.

value - The variable value.

createThreadEvent

IMonitoringEvent createThreadEvent(java.lang.String type,
                                   ProcessThread thread)

Create a thread event (creation, modification, termination).

createActivityEvent

IMonitoringEvent createActivityEvent(java.lang.String type,
                                     ProcessThread thread,
                                     MActivity activity)

Create an activity event (start, end).

getActivityHandler

IActivityHandler getActivityHandler(MActivity activity)

Get the activity handler for an activity.

Parameters:

actvity - The activity.

Returns:

The activity handler.

getTopLevelThread

ProcessThread getTopLevelThread()

Get the top level thread (is not executed and just acts as top level thread container).

step

void step(MActivity activity,
          IInternalAccess instance,
          ProcessThread thread,
          java.lang.Object event)

Make a process step, i.e. find the next edge or activity for a just executed thread.

Parameters:

activity - The activity to execute.

instance - The process instance.

thread - The process thread.

notify

void notify(MActivity activity,
            ProcessThread thread,
            java.lang.Object event)

Method that should be called, when an activity is finished and the following activity should be scheduled. Can safely be called from external threads.

Parameters:

activity - The timing event activity.

instance - The process instance.

thread - The process thread.

event - The event that has occurred, if any.

isReady

boolean isReady()

Check if the process is ready, i.e. if at least one process thread can currently execute a step.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

isReady

boolean isReady(java.lang.String pool,
                java.lang.String lane)

Check if the process is ready, i.e. if at least one process thread can currently execute a step.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

isFinished

boolean isFinished()

Check, if the process has terminated.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

Returns:

True, when the process instance is finished with regards to the specified pool/lane. When both pool and lane are null, true is returned only when all pools/lanes are finished.

isFinished

boolean isFinished(java.lang.String pool,
                   java.lang.String lane)

Check, if the process has terminated.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

Returns:

True, when the process instance is finished with regards to the specified pool/lane. When both pool and lane are null, true is returned only when all pools/lanes are finished.

getMessages

java.util.List<java.lang.Object> getMessages()

Get the messages.

Returns:

The messages

getStreams

java.util.List<IConnection> getStreams()

Get the streams.

Returns:

The streams