Interface CSReference

  • All Superinterfaces:
    PluginDataContainer, Serializable, UserAttributeContainer

    public interface CSReference
    extends UserAttributeContainer, PluginDataContainer, Serializable
    The lightweight representation of a ConfigurationSet for usage in the activity repository. This reference allows to return just the data necessary to display the ConfigurationSet 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:
    ConfigurationSet
    • Field Detail

      • serialVersionUID

        static final long serialVersionUID
        Generated ID for serialisation.
        See Also:
        Constant Field Values
    • Method Detail

      • getName

        String getName()
        Gets the system-wide unique name of the ConfigurationSet of this reference.
        Returns:
        The system-wide unique name of the ConfigurationSet of this reference.
        See Also:
        AbstractConfigurationSet.getName()
      • getDeveloperDescription

        String getDeveloperDescription()
        Gets a description for the developer of the configuration and the process modeler.
        Returns:
        A description for the developer of the configuration set and the process modeler. This description is not propagated to the process and is only part of the activity model.
      • getRevision

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

        State getState()
        Gets the current deployment state of the configuration set 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 configuration set of this reference that implicitly also applies to all child entities.
        See Also:
        AbstractConfigurationSet.getState()