|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OpenExecution
execution that opens up access to the related objects in the execution and process definition model. This execution exposes the execution hierarchy, variable access and associated timers. This is an execution that can be used backed by an open persistence session. Typically inside of an environment block. Navigation over the related model objects will load the related objects transparently with lazy loading.
Field Summary |
---|
Fields inherited from interface org.jbpm.api.Execution |
---|
STATE_ACTIVE_CONCURRENT, STATE_ACTIVE_ROOT, STATE_ASYNC, STATE_CREATED, STATE_ENDED, STATE_INACTIVE_CONCURRENT_ROOT, STATE_INACTIVE_JOIN, STATE_INACTIVE_SCOPE, STATE_SUSPENDED |
Method Summary | |
---|---|
void |
createVariable(java.lang.String key,
java.lang.Object value)
create a new variable in this execution scope and determine the type automagically. |
void |
createVariable(java.lang.String key,
java.lang.Object value,
java.lang.String typeName)
create a new variable in this execution scope with the given type name. |
OpenExecution |
findActiveExecutionIn(java.lang.String activityName)
search for an execution that is active and in the given activityName. |
OpenExecution |
getExecution(java.lang.String name)
the child execution for the given name or null in case such execution doesn't exist. |
OpenExecution |
getParent()
the parent execution in the execution structure. |
OpenProcessDefinition |
getProcessDefinition()
the process definition for this execution. |
OpenProcessInstance |
getProcessInstance()
the main path of execution in the execution structure. |
OpenExecution |
getSubProcessInstance()
the related sub process execution. |
java.lang.Object |
getVariable(java.lang.String key)
retrieve the value for the given key. |
java.util.Set<java.lang.String> |
getVariableKeys()
a non-null set that contains all the keys present in this scope. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariables()
a non-null map containing all the key-value pairs in this scope. |
boolean |
hasVariable(java.lang.String key)
indicates presenve of the given key. |
boolean |
hasVariables()
indicates if there are keys in this scope. |
boolean |
removeVariable(java.lang.String key)
remove the key-value pair for the given key from this scope. |
void |
removeVariables()
removes all variables in this scope |
void |
setPriority(int priority)
setter for the priority. |
void |
setState(java.lang.String state)
update the state |
void |
setVariable(java.lang.String key,
java.lang.Object value)
updates or creates a variable for the given value. |
void |
setVariables(java.util.Map<java.lang.String,?> variables)
sets all given variables. |
Methods inherited from interface org.jbpm.api.Execution |
---|
findActiveActivityNames, getExecutions, getExecutionsMap, getId, getKey, getName, getPriority, getProcessDefinitionId, getState, hasExecution, isActive, isEnded, isProcessInstance, isSuspended |
Methods inherited from interface org.jbpm.api.model.Discussable |
---|
createComment, getComments, removeComment |
Method Detail |
---|
OpenProcessDefinition getProcessDefinition()
void setState(java.lang.String state)
OpenExecution getSubProcessInstance()
java.lang.Object getVariable(java.lang.String key)
null
will always be null as null keys are not allowed.
void setVariable(java.lang.String key, java.lang.Object value)
JbpmException
- if key is null.void setVariables(java.util.Map<java.lang.String,?> variables)
sets
all given variables.
Existing key-value pairs for which there is no key in the provided
variables will not be removed.
JbpmException
- is variables is not null and if null is present
as a key in the provided variables map.boolean hasVariable(java.lang.String key)
boolean removeVariable(java.lang.String key)
void removeVariables()
boolean hasVariables()
java.util.Set<java.lang.String> getVariableKeys()
java.util.Map<java.lang.String,java.lang.Object> getVariables()
void createVariable(java.lang.String key, java.lang.Object value)
void createVariable(java.lang.String key, java.lang.Object value, java.lang.String typeName)
void setPriority(int priority)
OpenProcessInstance getProcessInstance()
getProcessInstance
in interface Execution
OpenExecution getParent()
getParent
in interface Execution
OpenExecution getExecution(java.lang.String name)
getExecution
in interface Execution
OpenExecution findActiveExecutionIn(java.lang.String activityName)
Execution
findActiveExecutionIn
in interface Execution
Execution.findActiveActivityNames()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |