public interface ExecutableBusinessProcessInstance extends PluginDataContainer, UserAttributeContainer
ExecutableBusinessProcessInstance is an instance of
ExecutableBusinessProcess
and also resembles the interface. It differs in its usage. The
ExecutableBusinessProcessInstance is for provision of the
appropriate information at runtime and may therefore contain
instance-specific data, whereas ExecutableBusinessProcess only
contains template-specific data. For instance, the name of an EBP may depend
on the value of a data element; this dependency will be resolved in the
ExecutableBusinessProcessInstance.| Modifier and Type | Method and Description |
|---|---|
ParameterDataContext |
getAttachedDataContext()
Gets the data context which provides the values of attached data elements.
|
Configuration |
getConfiguration()
Gets the configuration of this executable business process.
|
java.lang.String |
getDescription()
Returns the description of this executable business process instance.
|
ExecutionControlProperties |
getExecutionControlProperties()
Returns the execution control properties that reflect the abilities of this
executable business process instance on reacting to execution control
requests from the outside.
|
java.lang.String |
getGroupExecutionContext()
Gets the execution context of the group this EBP instance can be part of.
|
java.lang.String |
getGroupName()
Gets the name of the group this EBP instance can be part of.
|
java.util.UUID |
getIconID()
Gets the ID of the icon to use for process steps and worklist items of this
EBPInstance. |
java.lang.String |
getName()
Returns the name of this node/subprocess to be displayed in the
worklist or the called application.
|
ProcessModelParameter |
getParameter(java.lang.String name,
ActivityConstants.AccessType accessType)
Returns the parameter object linked to the passed parameter name.
|
java.util.Set<ProcessModelParameter> |
getParameters(ActivityConstants.AccessType accessType)
Returns set of parameter objects by which this Activity/subprocess is
provided with data values by the process management system or the set of
parameter objects by which the process management system is provided with
the calculation results of this component.
|
java.lang.String |
getProcessInstanceName()
Gets the resolved name of the (parent) process instance of the executable
business process of this
EBPInstance. |
java.lang.String |
getProcessTemplateName()
Gets the name of the (parent) process template of the executable business
process of this
EBPInstance. |
java.lang.String |
getProcessTemplateVersion()
Gets the logical version of the process template of the (parent) process
template of the executable business process of this
EBPInstance. |
java.lang.String |
getProcessType()
Gets the process type of the (parent) process template of the executable
business process of this
EBPInstance. |
getPluginData, getPluginDatas, getSupportedPluginsgetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuejava.lang.String getProcessType()
EBPInstance.java.lang.String getProcessTemplateVersion()
EBPInstance. This may be the empty string.java.lang.String getProcessTemplateName()
EBPInstance.java.lang.String getProcessInstanceName()
EBPInstance.java.lang.String getName()
java.lang.String getDescription()
java.util.UUID getIconID()
EBPInstance. With the ID the corresponding item can be
requested from an icon providing service in various sizes and formats.null in case the EBPInstance does not
have a specific icon.ExecutionControlProperties getExecutionControlProperties()
Configuration getConfiguration()
ProcessModelParameter getParameter(java.lang.String name, ActivityConstants.AccessType accessType)
name - The name of the parameteraccessType - The access type of the parameter.ProcessModelParameterjava.util.Set<ProcessModelParameter> getParameters(ActivityConstants.AccessType accessType)
accessType - the type of the parameter, i.e. READ or WRITE accessProcessModelParameterParameterDataContext getAttachedDataContext()
java.lang.String getGroupName()
java.lang.String getGroupExecutionContext()
group name and execution context can be represented by the
same worklist item. They can also be executed as group via an appropriate list, form or a
similar UI element. This element is specified by this group execution context. null or the empty string, the group is merely for structuring purpose.null
or the empty string for a group for structuring purpose. The execution context
specifies the UI element to use for the combined execution of the EBP instances of the
group.