Package de.aristaflow.adept2.model.activitymodel

Interface ATDReference

All Superinterfaces:
PluginDataContainer, Serializable, UserAttributeContainer
public interface ATDReference extends UserAttributeContainer, PluginDataContainer, Serializable
The lightweight representation of an ActivityTemplateDefinition for usage in the activity repository. This reference allows to return just the data necessary to display the ActivityTemplateDefinition 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    serialVersionUID
    Generated ID for serialisation.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBranch()
    Gets the branch of the activity template definition of this reference.
    String
    getConfigurationSetName()
    Gets the name of the configuration set or null if the ActivityTemplateDefinition of this reference does not have a configuration set.
    String
    getDescription()
    Gets a description for the ActivityTemplateDefinition of this reference for usage in the process model.
    String
    getDeveloperDescription()
    Gets a description of the ActivityTemplateDefinition of this reference for the developer and the administrator of the activity model.
    String
    getExecutableComponentName()
    Gets the system-wide unique name of the ExecutableComponentDescription of the ActivityTemplateDefinition of this reference.
    UUID
    getIconID()
    Gets the ID of the icon to use for process steps and worklist items for the operation of this reference.
    UUID
    getID()
    Gets the (world-wide) unique ID of the ActivityTemplateDefinition of this reference.
    String
    getName()
    Gets the name of the ActivityTemplateDefinition of this reference.
    String
    getOperationName()
    Gets the name of the operation (unique with respect to the ExecutableComponentDescription) of the ActivityTemplateDefinition of this reference.
    long
    getRevision()
    Gets the (base) revision of the activity template definition of this reference which allows to track changes.
    State
    getState()
    Gets the current deployment state of the ActivityTemplateDefinition of this reference that is whether it is currently modified, it can be used or it may not be used any more.

    Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

    getPluginData, getPluginDatas, getSupportedPlugins

    Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

    getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

  • Field Details

    • serialVersionUID

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

  • Method Details

    • getID

      UUID getID()
      Gets the (world-wide) unique ID of the ActivityTemplateDefinition of this reference.
      Returns:
      The (world-wide) unique ID of the ActivityTemplateDefinition of this reference.
      See Also:

    • getExecutableComponentName

      String getExecutableComponentName()
      Gets the system-wide unique name of the ExecutableComponentDescription of the ActivityTemplateDefinition of this reference.
      Returns:
      The system-wide unique name of the ExecutableComponentDescription of the ActivityTemplateDefinition of this reference.

    • getOperationName

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

    • getConfigurationSetName

      String getConfigurationSetName()
      Gets the name of the configuration set or null if the ActivityTemplateDefinition of this reference does not have a configuration set.
      Returns:
      The name of the configuration set or null if the ActivityTemplateDefinition of this reference does not have a configuration set.
      See Also:

    • getName

      String getName()
      Gets the name of the ActivityTemplateDefinition of this reference.
      Returns:
      The name of the ActivityTemplateDefinition of this reference.
      See Also:

    • getDescription

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

    • getDeveloperDescription

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

    • getRevision

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

    • getState

      State getState()
      Gets the current deployment state of the ActivityTemplateDefinition of this reference 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 the ActivityTemplateDefinition of this reference that may be kind of overridden by its parent entities.
      See Also:

    • getBranch

      long getBranch()
      Gets the branch of the activity template definition of this reference. In case of an activity template definition of a production version a negative value will be returned, for an activity template definition of a development version this will be the used branch.
      Returns:
      The branch of this activity template definition or a negative value in case this activity template definition is a production version.

    • 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: