Package de.aristaflow.adept2.model.activitymodel

Interface OperationReference

All Superinterfaces:
PluginDataContainer, Serializable, UserAttributeContainer
public interface OperationReference extends UserAttributeContainer, PluginDataContainer, Serializable
The lightweight representation of an Operation for usage in the activity repository. This reference allows to return just the data necessary to display the Operation to the user.

References are not subject of inheritance; all attributes are the result of merging the corresponding attributes of all parent entities. Therefore when changing an entity, always refresh the corresponding reference and all references of the children.

Author:
Ulrich Kreher
See Also:

  • Field Details

    • serialVersionUID

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

  • Method Details

    • getExecutableComponentName

      String getExecutableComponentName()
      Gets the name of the ExecutableComponentDescription the operation of this reference.
      Returns:
      The name of the ExecutableComponentDescription the operation of this reference belongs to.
      See Also:

    • getName

      String getName()
      Gets the name of the operation of this reference (unique with respect to the ExecutableComponentDescription).
      Returns:
      The name of the operation of this reference (unique with respect to the ExecutableComponentDescription).
      See Also:

    • getDescription

      String getDescription()
      Gets a description for the operation of this reference for usage in the process model.
      Returns:
      A description for the operation of this reference for usage in the process model that may be displayed in worklists.
      See Also:

    • getDeveloperDescription

      String getDeveloperDescription()
      Gets a description for the developer of the operation and the administrator of the activity model.
      Returns:
      A description for the developer of the operation and the administrator of the activity model.
      See Also:

    • getRevision

      long getRevision()
      Gets the (base) revision of the operation of this reference which allows to track changes. In case of an operation of a production version the corresponding revision will be returned, for an operation of a development version this will be the base revision of the appropriate branch.
      Returns:
      The (base) revision of this operation which allows to track changes.
      See Also:

    • getState

      State getState()
      Gets the current deployment state of this operation, that is whether it is currently modified, it can be used or it may not be used any more.
      Returns:
      The current deployment state of this operation that implicitly also applies to all child entities.
      See Also:

    • getIconID

      UUID getIconID()
      Gets the ID of the icon to use for process steps and worklist items for the operation of this reference.
      Returns:
      The ID of the icon to use for process steps and worklist items.
      See Also: