Package de.aristaflow.adept2.model.activitymodel

Interface AbstractActivityTemplateDefinition

All Superinterfaces:
PluginDataContainer, UserAttributeContainer
All Known Subinterfaces:
ActivityTemplateDefinition, StorageActivityTemplateDefinition
public interface AbstractActivityTemplateDefinition extends PluginDataContainer, UserAttributeContainer
This interface unifies the methods of an ActivityTemplateDefinition used with inheritance (in the GUI) as well as for storage.
Author:
Ulrich Kreher

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    areExecutionControlPropertiesInherited()
    Gets whether this activity template definition inherits the execution control properties from its operation.
    ClassLoaderUsage
    getClassLoaderUsage()
    Gets what classloader to use for the executable component of this activity template definition.
    String
    getDescription()
    Gets a description for this activity template definition for usage in the process model.
    String
    getDeveloperDescription()
    Gets a description for the developer of the activity template definition and the administrator of the activity model.
    ExecutionControlProperties
    getExecutionControlProperties()
    Gets the interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the component responds to signals from the outside to suspend, reset or close the component.
    String
    getGUIContextID()
    Gets the ID of the GUI context the executable component of this activity template definition needs, for instance, an SWT or an AWT context.
    UUID
    getIconID()
    Gets the ID of the icon to use for process steps and worklist items of the underlying executable component.
    UUID
    getID()
    Gets the (world-wide) unique ID of the ActivityTemplateDefinition this activity template definition is based upon.
    String
    getImplementationClass()
    Gets the name of the class implementing ExecutableComponent which is called when the process node is executed for which this activity template definition is for.
    String
    getLicenceInformation()
    Gets the licence information for this activity template definition.
    String
    getName()
    Gets the name of this activity template definition.
    ParameterChangePolicy
    getParameterChangePolicy()
    Gets the parameter change policy for the operation of this activity, that is the supported interface changes for this operation (add, change and/or remove parameters).
    long
    getRevision()
    Gets the (base) revision of this activity template definition which allows to track changes.
    String
    getStaffAssignmentRule()
    Gets the staff assignment rule that is proposed by the developer of the operation or the administrator of the activity model.
    State
    getState()
    Gets the current deployment state of this activity template definition, that is whether it is currently modified, it can be used or it may not be used any more.
    byte[]
    getSystemComponent()
    Gets the signature in case the executable component of this activity template definition is privileged component and may access system services.
    boolean
    isClassLoaderUsageInherited()
    Gets whether this activity template definition inherits the classloader usage from its operation.
    boolean
    isDescriptionInherited()
    Gets whether this activity template definition inherits the description from its operation.
    boolean
    isDeveloperDescriptionInherited()
    Gets whether this activity template definition inherits the developer description from its operation.
    boolean
    isGUIContextIDInherited()
    Gets whether this activity template definition inherits the GUI context ID from its operation.
    boolean
    isIconIDInherited()
    Gets whether this activity template definition inherits the icon from its executable component description.
    boolean
    isImplementationClassInherited()
    Gets whether this activity template definition inherits the implementation class from its operation.
    boolean
    isLicenceInformationInherited()
    Gets whether this activity template definition inherits the licence information from its operation.
    boolean
    isParameterChangePolicyInherited()
    Gets whether this activity template definition inherits the parameter change policy from its operation.
    boolean
    isStaffAssignmentRuleInherited()
    Gets whether this activity template definition inherits the staff assignment rule from its configuration set or its operation (depending on whether ActivityTemplateDefinition.getConfigurationSet() returns a valid configuration set).
    boolean
    isSupportsTestExecutionInherited()
    Gets whether this activity template definition inherits the supports test execution flag from its operation.
    boolean
    isSupportsViewOnlyInherited()
    Gets whether this activity template definition inherits the supports view only flag from its operation.
    boolean
    isSystemComponentInherited()
    Gets whether this activity template definition inherits the system component signature from its operation.
    void
    removeOwnClassLoaderUsage()
    Removes the classloader usage of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnDescription()
    Removes the description of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnDeveloperDescription()
    Removes the developer description of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnExecutionControlProperties()
    Removes the execution control properties of this activity template definition and inherits them from the corresponding operation again.
    void
    removeOwnGUIContextID()
    Removes the GUI context ID of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnIconID()
    Removes the icon of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnImplementationClass()
    Removes the implementation class of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnLicenceInformation()
    Removes the licence information of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnParameterChangePolicy()
    Removes the parameter change policy of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnStaffAssignmentRule()
    Removes the staff assignment rule of this activity template definition and inherits the value from the corresponding configuration set or operation again.
    void
    removeOwnSupportsTestExecution()
    Removes the supports test execution flag of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnSupportsViewOnly()
    Removes the supports view only flag of this activity template definition and inherits the value from the corresponding operation again.
    void
    removeOwnSystemComponent()
    Removes the system component signature of this activity template definition and inherits the value from the corresponding operation again.
    void
    setClassLoaderUsage(ClassLoaderUsage classLoaderUsage)
    Sets what classloader to use for the executable component of this activity template definition.
    void
    setDescription(String description)
    Sets a description for this activity template definition for usage in the process model.
    void
    setDeveloperDescription(String developerDescription)
    Sets a description for the developer of the operation of this activity template definition and the administrator of the activity model.
    void
    setExecutionControlProperties(ExecutionControlProperties ecp)
    Sets the interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the corresponding component responds to signals from the outside to suspend, reset or close the component.
    void
    setGUIContextID(String guiContextID)
    Sets the ID of the GUI context the executable component of this activity template definition needs, for instance, an SWT or an AWT context; or GUIConstants.NULL_CONTEXT if no GUI context is required.
    void
    setIconID(UUID iconID)
    Sets the ID of the icon to use for process steps and worklist items for this activity template definition.
    void
    setID(UUID id)
    sets the (world-wide) unique ID of the ActivityTemplateDefinition this activity template definition is based upon.
    void
    setImplementationClass(String implementationClass)
    Sets the name of the class implementing ExecutableComponent for the physical counterpart of the component description of this activity template definition.
    void
    setLicenceInformation(String licenceInformation)
    Sets the licence information for this activity template definition.
    void
    setName(String name)
    Sets the name of this activity template definition.
    void
    setParameterChangePolicy(ParameterChangePolicy pcp)
    Sets the parameter change policy for the operation of this activity template definition, that is the supported interface changes for the operation (add, change and/or remove parameters).
    void
    setStaffAssignmentRule(String staffAssignmentRule)
    Sets the staff assignment rule that is proposed by the developer of the operation of this activity template definition or the administrator of the activity model.
    void
    setSupportsTestExecution(boolean supportsTestExecution)
    Sets whether the operation of this activity template definition supports a test execution.
    void
    setSupportsViewOnly(boolean supportsViewOnly)
    Sets whether the operation of this activity template definition supports a view only mode.
    void
    setSystemComponent(byte[] signature)
    Sets the signature for the executable component of this activity template which allows privileged access to system services.
    boolean
    supportsTestExecution()
    Gets whether the operation if this activity template definition supports a test execution.
    boolean
    supportsViewOnly()
    Gets whether the operation of this activity template definition supports a view only mode.

    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

  • Method Details

    • getID

      UUID getID()
      Gets the (world-wide) unique ID of the ActivityTemplateDefinition this activity template definition is based upon. This changes with every revision and thus allows to identify a revision since the normal revision does not suffice to identify an ActivityTemplateDefinition since two different activity models usually go through the very same revisions but with different changes.
      Returns:
      The (world-wide) unique ID (including the revision) of the ActivityTemplateDefinition this activity template definition is based upon.

    • setID

      void setID(UUID id)
      sets the (world-wide) unique ID of the ActivityTemplateDefinition this activity template definition is based upon. This changes with every revision and thus allows to identify a revision since the normal revision does not suffice to identify an ActivityTemplateDefinition since two different activity models usually go through the very same revisions but with different changes.
      Parameters:
      id - The (world-wide) unique ID (including the revision) of the ActivityTemplateDefinition this activity template definition is based upon.

    • getName

      String getName()
      Gets the name of this activity template definition. This name is used as default name for the corresponding process node which in turn is used in worklists to allow the end user to identify the corresponding worklist item.
      Returns:
      The name of this activity template definition.

    • getDescription

      String getDescription()
      Gets a description for this activity template definition for usage in the process model. This description is used as default description for the corresponding process node which in turn is used in worklists to allow the end user to identify the corresponding worklist item.
      Returns:
      A description for this activity template definition for usage in the process model that may be displayed in worklists.

    • getDeveloperDescription

      String getDeveloperDescription()
      Gets a description for the developer of the activity template definition and the administrator of the activity model.

      This attribute overrides the corresponding parent attribute.

      Returns:
      A description for the developer of the activity template definition and the administrator of the activity model. This description is not propagated to the process and is only part of the activity model.

    • getRevision

      long getRevision()
      Gets the (base) revision of this activity template definition which allows to track changes. To modify an activity template definition it needs to be in a development branch. As soon as it is changed, its state is set to IN_DEVELOPMENT but the revision remains until the branch is released.
      Changing the revision (releasing) leads to a new unique ID.
      Returns:
      The revision of this activity template definition or the revision which it is based upon.

    • getState

      State getState()
      Gets the current deployment state of this activity template definition, that is whether it is currently modified, it can be used or it may not be used any more. The states of the parent entities also apply to this entity. However, the state is not directly propagated to child entities. Rather before using an entity all of its parent entities (ExecutableComponentDescription, Operation and ConfigurationSethave to be checked for their state.
      Returns:
      The current deployment state of this activity template definition that may be kind of overridden by its parent entities.

    • getImplementationClass

      String getImplementationClass()
      Gets the name of the class implementing ExecutableComponent which is called when the process node is executed for which this activity template definition is for. The classpath needs to be set appropriately.
      An implementation class is not required for with the runtime service, therefore for such activity template definitions null may be exceptionally returned.

      This attribute overrides the corresponding parent attribute.

      Returns:
      The name of the class implementing ExecutableComponent which is called when the process node is executed for which this activity template definition is for. This may exceptionally be null for activity template definitions that are only to be executed with the runtime service.

    • getClassLoaderUsage

      ClassLoaderUsage getClassLoaderUsage()
      Gets what classloader to use for the executable component of this activity template definition. This may be a specific classloader for each execution, a shared classloader for all executions of the very same executable component on the same runtime manager and the classloader of the AristaFlow platform.

      This attribute overrides the corresponding parent attribute.

      Returns:
      What classloader to use for executable component of this activity template definition; one for each execution, shared for all executions of the same activity or the classloader of the AristaFlow platform.

    • getSystemComponent

      byte[] getSystemComponent()
      Gets the signature in case the executable component of this activity template definition is privileged component and may access system services. Such an executable component receives a registry in the constructor and may use this to retrieve the needed services.
      The system component signature allows to verify the component. Null indicates a non-system component

      This attribute overrides the corresponding parent attribute.

      Returns:
      A signature to verify the component to prevent harmful components from system access or null for non-system components.

    • getGUIContextID

      String getGUIContextID()
      Gets the ID of the GUI context the executable component of this activity template definition needs, for instance, an SWT or an AWT context. This is provided at runtime and allows the component to render its graphical user interface to.

      This attribute overrides the corresponding parent attribute.

      Returns:
      The ID of the GUI context the executable component of this activity template definition needs to render its graphical user interface to. This will be GUIConstants.NULL_CONTEXT if no GUI context is required.

    • getExecutionControlProperties

      ExecutionControlProperties getExecutionControlProperties()
      Gets the interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the component responds to signals from the outside to suspend, reset or close the component.

      This attribute overrides the corresponding parent attribute.

      Returns:
      The interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the component responds to signals from the outside to suspend, reset or close the component.

    • supportsViewOnly

      boolean supportsViewOnly()
      Gets whether the operation of this activity template definition supports a view only mode. In this mode the operation is executed normally but all of its output parameters are provided very similar to input parameters. The operation should then just display its input and output values. This allows to reproduce the execution of an operation later and thus improves traceability of a process. Since the operation must not write output, this mode has to be explicitly supported.
      Returns:
      Whether the operation of this activity template definition supports a view only mode to re-execute the operation only for displaying input data as well as the formerly written output data.
      See Also:

    • supportsTestExecution

      boolean supportsTestExecution()
      Gets whether the operation if this activity template definition supports a test execution. If so, the operation will be able to run in a special test environment with a test configuration which does not have any critical side effects. The operation is provided a flag at runtime whether it is in test mode.
      Returns:
      Whether the operation of this abstract activity supports a test mode without any critical side effects.
      See Also:

    • getIconID

      UUID getIconID()
      Gets the ID of the icon to use for process steps and worklist items of the underlying executable component. With the ID the corresponding item can be requested from an icon providing service in various sizes and formats.

      This attribute overrides the corresponding parent attribute.

      Returns:
      The ID of the icon to use for process steps and worklist items; the corresponding icon may be retrieved in various sizes and formats. This may be null if no icon is specified.

    • getLicenceInformation

      String getLicenceInformation()
      Gets the licence information for this activity template definition. This may specify legal stuff for using the corresponding component.

      This attribute overrides the corresponding parent attribute.

      Returns:
      The licence information for this activity template definition or an empty string.

    • getParameterChangePolicy

      ParameterChangePolicy getParameterChangePolicy()
      Gets the parameter change policy for the operation of this activity, that is the supported interface changes for this operation (add, change and/or remove parameters).
      Returns:
      The parameter change policy for the operation of this activity that specifies the supported interface changes for the operation.

    • getStaffAssignmentRule

      String getStaffAssignmentRule()
      Gets the staff assignment rule that is proposed by the developer of the operation or the administrator of the activity model.
      An empty string will be returned if this is undefined.

      This rule is either set in this activity template definition or inherited from the corresponding operation.

      Returns:
      The staff assignment rule that is proposed by the developer of the operation or the administrator of the activity model or an empty string.

    • setName

      void setName(String name)
      Sets the name of this activity template definition. This has to be unique with respect to the corresponding Operation. This name is used as default name for the corresponding process node which in turn is used in worklists to allow the end user to identify the corresponding worklist item.
      Due to its usage as identification for configurations, the name may only be changed for an activity template definition that does not have a released revision yet.

      This must neither be null nor the empty string. The designated name must not exist for the executable component description.

      Parameters:
      name - The name of this activity template definition (unique with respect to the Operation) which is used as default name for the corresponding process node. This must neither be null nor the empty string.

    • setDescription

      void setDescription(String description)
      Sets a description for this activity template definition for usage in the process model. This describes the operation and may be displayed in the worklist of the end-user.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      description - A description for this activity template definition for usage in the process model that may be displayed in worklists. Use the empty string to unset the description.

    • setDeveloperDescription

      void setDeveloperDescription(String developerDescription)
      Sets a description for the developer of the operation of this activity template definition and the administrator of the activity model.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      developerDescription - A description for the developer of the operation and the administrator of the activity model. This description is not propagated to the process and is only part of the activity model. Use the empty string to unset the developer description for this entity.

    • setImplementationClass

      void setImplementationClass(String implementationClass)
      Sets the name of the class implementing ExecutableComponent for the physical counterpart of the component description of this activity template definition.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      implementationClass - The name of the class implementing ExecutableComponent for the physical counterpart of the component description of this activity template definition which is instantiated and called at runtime.

    • setClassLoaderUsage

      void setClassLoaderUsage(ClassLoaderUsage classLoaderUsage)
      Sets what classloader to use for the executable component of this activity template definition. This may be a specific classloader for each execution, a shared classloader for all executions of the very same executable component on the same runtime manager and the classloader of the AristaFlow platform.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      classLoaderUsage - What classloader to use for executable component of this activity template definition; one for each execution, shared for all executions of the same activity or the classloader of the AristaFlow platform.

    • setSystemComponent

      void setSystemComponent(byte[] signature)
      Sets the signature for the executable component of this activity template which allows privileged access to system services.

      This attribute overrides the corresponding parent attribute. This is only allowed in case this activity template definition provides an own implementation.

      Parameters:
      signature - A signature to verify the component to prevent harmful components from system access. Use null for a non-system component.

    • setGUIContextID

      void setGUIContextID(String guiContextID)
      Sets the ID of the GUI context the executable component of this activity template definition needs, for instance, an SWT or an AWT context; or GUIConstants.NULL_CONTEXT if no GUI context is required.

      This attribute overrides the corresponding parent attribute. This is only allowed in case this activity template definition provides an own implementation.

      Parameters:
      guiContextID - The ID of the GUI context the executable component of this activity template definition needs to render its graphical user interface to. Use GUIConstants.NULL_CONTEXT in case no GUI context is needed.

    • setExecutionControlProperties

      void setExecutionControlProperties(ExecutionControlProperties ecp)
      Sets the interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the corresponding component responds to signals from the outside to suspend, reset or close the component.

      This attribute overrides the corresponding parent attribute. Overriding will only be allowed to more restrictive properties, that is, suspending, reseting or closing may be prevented by overriding but not enabled if this activity template definition does not specify an own implementation.

      Parameters:
      ecp - The interactions that the executable component of this activity template definition supports for controlling its execution, that is whether the component responds to signals from the outside to suspend, reset or close the component. Only more restrictive properties are allowed when overriding in case of an inherited implementation. Call removeOwnExecutionControlProperties() to inherit the properties from the parent entity.

    • setSupportsViewOnly

      void setSupportsViewOnly(boolean supportsViewOnly)
      Sets whether the operation of this activity template definition supports a view only mode.

      This attribute overrides the corresponding parent attribute. Overriding will only be allowed to restrict, that is, view only may be prohibited but not allowed if this activity template definition does not specify an own implementation.

      Parameters:
      supportsViewOnly - Whether the operation of this activity template definition supports a view only mode to re-execute the operation only for displaying input data as well as the formerly written output data.
      See Also:

    • setSupportsTestExecution

      void setSupportsTestExecution(boolean supportsTestExecution)
      Sets whether the operation of this activity template definition supports a test execution. If so, the operation will be able to run in a special test environment with a test configuration which does not have any critical side effects. The operation is provided a flag at runtime whether it is in test mode.

      This attribute overrides the corresponding parent attribute. Overriding will only be allowed to restrict, that is, view only may be prohibited but not allowed if this activity template definition does not specify an own implementation.

      Parameters:
      supportsTestExecution - Whether the operation of this activity template definition supports a test mode without any critical side effects.
      See Also:

    • setIconID

      void setIconID(UUID iconID)
      Sets the ID of the icon to use for process steps and worklist items for this activity template definition. With the ID the corresponding item can be requested from an icon providing service in various sizes and formats.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      iconID - The ID of the icon to use for process steps and worklist items; the corresponding icon may be retrieved in various sizes and formats. This must not be null since it is not allowed to remove the icon of the parent entity.

    • setLicenceInformation

      void setLicenceInformation(String licenceInformation)
      Sets the licence information for this activity template definition.

      This attribute overrides the corresponding parent attribute.

      Parameters:
      licenceInformation - The licence information for this activity template definition as arbitrary string or the empty string.

    • setParameterChangePolicy

      void setParameterChangePolicy(ParameterChangePolicy pcp)
      Sets the parameter change policy for the operation of this activity template definition, that is the supported interface changes for the operation (add, change and/or remove parameters). However, the parameters of this activity template definition may always be changed independent from this policy, that is the policy applies to the offspring of this activity template definition. But it does apply to the parameter templates!

      This attribute overrides the corresponding parent attribute. Overriding will only be allowed to restrict, that is, the interface of the operation may be changed less if this activity template definition does not specify an own implementation. The following order applies to the restrictions:

      Parameters:
      pcp - The parameter change policy for the operation of this activity template definition that specifies the supported interface changes for the operation. This must not be null.
      The parameter change policy applies to the parameters of the offspring of this activity template definition and the parameter templates of the operation.

    • setStaffAssignmentRule

      void setStaffAssignmentRule(String staffAssignmentRule)
      Sets the staff assignment rule that is proposed by the developer of the operation of this activity template definition or the administrator of the activity model.

      This attribute overrides the corresponding parent attribute (AbstractConfigurationSet.setStaffAssignmentRule(String) or AbstractOperation.setStaffAssignmentRule(String)).

      Parameters:
      staffAssignmentRule - The staff assignment rule that is proposed by the developer of the operation of this activity template definition or the administrator of the activity model or an empty string.

    • isDescriptionInherited

      boolean isDescriptionInherited()
      Gets whether this activity template definition inherits the description from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the description from the corresponding operation or whether it overrides it with the value provided by getDescription().

    • removeOwnDescription

      void removeOwnDescription()
      Removes the description of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the description is already inherited.

    • isDeveloperDescriptionInherited

      boolean isDeveloperDescriptionInherited()
      Gets whether this activity template definition inherits the developer description from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the developer description from the corresponding operation or whether it overrides it with the value provided by getDeveloperDescription().

    • removeOwnDeveloperDescription

      void removeOwnDeveloperDescription()
      Removes the developer description of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the developer description is already inherited.

    • isImplementationClassInherited

      boolean isImplementationClassInherited()
      Gets whether this activity template definition inherits the implementation class from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the implementation class from the corresponding operation or whether it overrides it with the value provided by getImplementationClass().

    • removeOwnImplementationClass

      void removeOwnImplementationClass()
      Removes the implementation class of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the implementation class is already inherited.

    • isClassLoaderUsageInherited

      boolean isClassLoaderUsageInherited()
      Gets whether this activity template definition inherits the classloader usage from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the classloader usage from the corresponding operation or whether it overrides it with the value provided by getClassLoaderUsage().

    • removeOwnClassLoaderUsage

      void removeOwnClassLoaderUsage()
      Removes the classloader usage of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the classloader usage is already inherited.

    • isSystemComponentInherited

      boolean isSystemComponentInherited()
      Gets whether this activity template definition inherits the system component signature from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the system component signature from the corresponding operation or whether it overrides it with the value provided by getSystemComponent().

    • removeOwnSystemComponent

      void removeOwnSystemComponent()
      Removes the system component signature of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the system component signature is already inherited.

    • isGUIContextIDInherited

      boolean isGUIContextIDInherited()
      Gets whether this activity template definition inherits the GUI context ID from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the GUI context ID from the corresponding operation or whether it overrides it with the value provided by getGUIContextID().

    • removeOwnGUIContextID

      void removeOwnGUIContextID()
      Removes the GUI context ID of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the GUI context ID is already inherited.

    • areExecutionControlPropertiesInherited

      boolean areExecutionControlPropertiesInherited()
      Gets whether this activity template definition inherits the execution control properties from its operation. If it does not, it will override them with own values but only more restrictive ones.
      Returns:
      Whether this activity template definition inherits the GUI context ID from the corresponding operation or whether it overrides it with the value provided by getGUIContextID().

    • removeOwnExecutionControlProperties

      void removeOwnExecutionControlProperties()
      Removes the execution control properties of this activity template definition and inherits them from the corresponding operation again.
      Calling this method will have no effects if the execution control properties are already inherited.

      The execution control properties will also be removed from this activity template definition.

    • isSupportsViewOnlyInherited

      boolean isSupportsViewOnlyInherited()
      Gets whether this activity template definition inherits the supports view only flag from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the supports view only flag from the corresponding operation or whether it overrides it with the value provided by supportsViewOnly().

    • removeOwnSupportsViewOnly

      void removeOwnSupportsViewOnly()
      Removes the supports view only flag of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the supports view only flag is already inherited.

    • isSupportsTestExecutionInherited

      boolean isSupportsTestExecutionInherited()
      Gets whether this activity template definition inherits the supports test execution flag from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the supports test execution flag from the corresponding operation or whether it overrides it with the value provided by supportsViewOnly().

    • removeOwnSupportsTestExecution

      void removeOwnSupportsTestExecution()
      Removes the supports test execution flag of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the supports view only flag is already inherited.

    • isIconIDInherited

      boolean isIconIDInherited()
      Gets whether this activity template definition inherits the icon from its executable component description. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the icon from the corresponding operation or whether it overrides it with the value provided by getIconID().

    • removeOwnIconID

      void removeOwnIconID()
      Removes the icon of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the icon is already inherited.

    • isLicenceInformationInherited

      boolean isLicenceInformationInherited()
      Gets whether this activity template definition inherits the licence information from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the licence information from the corresponding operation or whether it overrides it with the value provided by getLicenceInformation().

    • removeOwnLicenceInformation

      void removeOwnLicenceInformation()
      Removes the licence information of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the licence information is already inherited.

    • isParameterChangePolicyInherited

      boolean isParameterChangePolicyInherited()
      Gets whether this activity template definition inherits the parameter change policy from its operation. If it does not, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the parameter change policy from the corresponding operation or whether it overrides it with the value provided by getParameterChangePolicy().

    • removeOwnParameterChangePolicy

      void removeOwnParameterChangePolicy()
      Removes the parameter change policy of this activity template definition and inherits the value from the corresponding operation again.
      Calling this method will have no effects if the parameter change policy is already inherited.

    • isStaffAssignmentRuleInherited

      boolean isStaffAssignmentRuleInherited()
      Gets whether this activity template definition inherits the staff assignment rule from its configuration set or its operation (depending on whether ActivityTemplateDefinition.getConfigurationSet() returns a valid configuration set). If it does not inherit the staff assignment rule, it will override it with an own value.
      Returns:
      Whether this activity template definition inherits the staff assignment rule from the corresponding configuration set or operation or whether it overrides it with the value provided by getStaffAssignmentRule().

    • removeOwnStaffAssignmentRule

      void removeOwnStaffAssignmentRule()
      Removes the staff assignment rule of this activity template definition and inherits the value from the corresponding configuration set or operation again.
      Calling this method will have no effects if the staff assignment rule is already inherited.