Interface ActivityInstance

All Superinterfaces:
AbstractActivity, ExecutableBusinessProcessInstance, PluginDataContainer, Serializable, UserAttributeContainer
All Known Subinterfaces:
DecisionActivityInstance

public interface ActivityInstance extends ExecutableBusinessProcessInstance, AbstractActivity, Serializable
The ActivityInstance is an instance of Activity and also resembles the interface. Its usage is analogue to ExecutableBusinessProcessInstance, which means, this ActivityInstance provides the information needed at runtime and represents the activity of an instance, whereas Activity only contains template-specific data.
Author:
Ulrich Kreher
  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      Generated ID for serialisation.
      See Also:
  • Method Details

    • getConfiguration

      ActivityConfiguration getConfiguration()
      Gets the configuration of this activity instance. This configuration is already merged with respect to the configurations from the activity model. It may also contain the global and local overriding configurations. In case of a test execution, this will be the fully merged test configuration.
      Note that an activity configuration will be returned but this does not contain any unresolved values to be retrieved from an input parameter or the process configuration! The returned configuration provides real values for its configuration entries.
      Specified by:
      getConfiguration in interface AbstractActivity
      Specified by:
      getConfiguration in interface ExecutableBusinessProcessInstance
      Returns:
      The configuration values set for this activity instance, which are merged from all appropriate configurations including test configurations if needed. This does not contain values retrieved from parameters or process configurations any more - although being an ActivityConfiguration.
    • getParameter

      Description copied from interface: ExecutableBusinessProcessInstance
      Returns the parameter object linked to the passed parameter name. The parameter name is the symbolic name by which an application component can retrieve a data value from the data context of the process management system.
      Specified by:
      getParameter in interface AbstractActivity
      Specified by:
      getParameter in interface ExecutableBusinessProcessInstance
      Parameters:
      name - The name of the parameter
      accessType - The access type of the parameter.
      Returns:
      the corresponding parameter object
      See Also:
    • getParameters

      Description copied from interface: ExecutableBusinessProcessInstance
      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. The actual content of the set depends on the parameter accessType which determines, if the parameters for READ or WRITE access are required.
      Specified by:
      getParameters in interface AbstractActivity
      Specified by:
      getParameters in interface ExecutableBusinessProcessInstance
      Parameters:
      accessType - the type of the parameter, i.e. READ or WRITE access
      Returns:
      the set of the parameters of this component, either READ or WRITE parameters, according to the parameter accessType
      See Also: