|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientExecution
view upon an path of execution
exposed to external clients.
Field Summary |
---|
Fields inherited from interface org.ow2.bonita.pvm.Execution |
---|
STATE_ACTIVE, STATE_ASYNC, STATE_CANCELLED, STATE_CREATED, STATE_ENDED, STATE_INACTIVE, STATE_SUSPENDED |
Method Summary | |
---|---|
void |
cancel()
ends this execution and assigns the state Execution.STATE_CANCELLED . |
void |
end()
ends this execution and all of its child executions. |
void |
end(java.lang.String state)
ends this execution and all it's child executions with a user defined status. |
void |
resume()
resumes an execution. |
void |
signal()
feeds a external trigger into this execution. |
void |
signal(Execution execution)
feeds a external trigger into the given execution. |
void |
signal(java.util.Map<java.lang.String,java.lang.Object> parameters)
feeds an external trigger into the execution with
parameters. |
void |
signal(java.util.Map<java.lang.String,java.lang.Object> parameters,
Execution execution)
feeds an external trigger into a given execution with
parameters. |
void |
signal(java.lang.String signalName)
feeds a named external trigger into the execution. |
void |
signal(java.lang.String signalName,
Execution execution)
feeds a named external trigger into a given execution. |
void |
signal(java.lang.String signalName,
java.util.Map<java.lang.String,java.lang.Object> parameters)
feeds a named external trigger into the execution with
parameters. |
void |
signal(java.lang.String signalName,
java.util.Map<java.lang.String,java.lang.Object> parameters,
Execution execution)
feeds a named external trigger into a given execution
with parameters. |
void |
suspend()
suspends this execution and all it's child executions. |
Methods inherited from interface org.ow2.bonita.pvm.model.OpenExecution |
---|
createVariable, createVariable, getExecution, getExecutions, getExecutionsMap, getJobs, getNode, getParent, getProcessDefinition, getProcessInstance, getSubProcessInstance, getVariable, getVariableKeys, getVariables, hasExecution, hasVariable, hasVariables, removeVariable, removeVariables, setPriority, setVariable, setVariables |
Methods inherited from interface org.ow2.bonita.pvm.Execution |
---|
getDbid, getId, getKey, getName, getNodeName, getPriority, getState, isActive, isEnded, isFinished, isLocked, isSuspended |
Methods inherited from interface org.ow2.bonita.pvm.model.Discussable |
---|
createComment, getComments, removeComment |
Method Detail |
---|
void end()
All child executions will be stopped and removed. This execution will not be removed from its parent.
This method should not be called in Activity
s. It can be called
from outside the process execution and in ExternalActivity
s.
void cancel()
Execution.STATE_CANCELLED
.
end(String)
void end(java.lang.String state)
void signal()
Typically a signal causes the execution to proceed, but that doesn't
necessarily has to be the case . The ExternalActivity
is
responsible for interpreting the signal and acting upon it.
A signal can optionally be given a signal name
,
a map of parameters
or both
.
Since it's an external trigger, this method requires that this execution is
waiting for an external trigger. So this method must be called as an
external client and can not be called while this execution is executing. In
an Activity
for example you're not allowed to call the signal on
the execution cause it is executing. But you are allowed to invoke this
method on any other execution (at least, if that one is waiting for an
external trigger).
Typically a signal will cause the execution to start executing, but that is
not a must. What happens with this signal is defined in the
ExternalActivity#signal(Execution, String, Map)
of the
current node
.
signal(String)
void signal(java.lang.String signalName)
external trigger
into the execution.
In each state, a number of things can happen. The signal parameter specifies which of these things is happening. It's somewhat similar to a method name in the invocation of an object.
See the unnamed signal for more information
void signal(java.util.Map<java.lang.String,java.lang.Object> parameters)
an external trigger
into the execution with
parameters.
See the unnamed signal for more information
void signal(java.lang.String signalName, java.util.Map<java.lang.String,java.lang.Object> parameters)
external trigger
into the execution with
parameters.
In each state, a number of things can happen. The signal parameter specifies which of these things is happening. It's somewhat similar to a method name in the invocation of an object.
The parameters parameter provide extra information to the signal.
Typically, the parameters are set as variables but the process language can
overwrite that behaviour in the current node. See
ExternalActivity#signal(Execution, String, Map)
for more
information.
See the unnamed signal for more information
void signal(Execution execution)
Typically a signal causes the execution to proceed, but that doesn't
necessarily has to be the case . The ExternalActivity
is
responsible for interpreting the signal and acting upon it.
A signal can optionally be given a signal name
,
a map of parameters
or both
.
Since it's an external trigger, this method requires that this execution is
waiting for an external trigger. So this method must be called as an
external client and can not be called while this execution is executing. In
an Activity
for example you're not allowed to call the signal on
the execution cause it is executing. But you are allowed to invoke this
method on any other execution (at least, if that one is waiting for an
external trigger).
Typically a signal will cause the execution to start executing, but that is
not a must. What happens with this signal is defined in the
ExternalActivity#signal(Execution, String, Map)
of the
current node
.
signal(String)
void signal(java.lang.String signalName, Execution execution)
external trigger
into a given execution.
In each state, a number of things can happen. The signal parameter specifies which of these things is happening. It's somewhat similar to a method name in the invocation of an object.
See the unnamed signal for more information
void signal(java.util.Map<java.lang.String,java.lang.Object> parameters, Execution execution)
an external trigger
into a given execution with
parameters.
See the unnamed signal for more information
void signal(java.lang.String signalName, java.util.Map<java.lang.String,java.lang.Object> parameters, Execution execution)
external trigger
into a given execution
with parameters.
In each state, a number of things can happen. The signal parameter specifies which of these things is happening. It's somewhat similar to a method name in the invocation of an object.
The parameters parameter provide extra information to the signal.
Typically, the parameters are set as variables but the process language can
overwrite that behaviour in the current node. See
ExternalActivity#signal(Execution, String, Map)
for more
information.
See the unnamed signal for more information
void suspend()
PvmException
- if this execution is already suspended.void resume()
suspend()
.
PvmException
- if this execution is not suspended.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |