de.aristaflow.adept2.model.activitymodel

Interface ECDReference

All Superinterfaces:

PluginDataContainer, java.io.Serializable, UserAttributeContainer

public interface ECDReference
extends UserAttributeContainer, PluginDataContainer, java.io.Serializable

The lightweight representation of an ExecutableComponentDescription for usage in the activity repository. This reference allows to return just the data necessary to display the ExecutableComponentDescription 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:

ExecutableComponentDescription

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeveloperDescription() Gets a description for the developer of the component and the administrator of the activity model.
java.util.UUID	getIconID() Gets the ID of the icon to use for process steps and worklist items of the underlying executable component.
java.lang.String	getName() Gets the system-wide unique name of the ExecutableComponentDescription of this reference.
long	getRevision() Gets the (base) revision of the executable component description of this reference which allows to track changes.
State	getState() Gets the current deployment state of the component description 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.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

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

getPluginData, getPluginDatas, getSupportedPlugins

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Gets the system-wide unique name of the ExecutableComponentDescription of this reference.

Returns:

The system-wide unique name of the ExecutableComponentDescription of this reference.

See Also:

AbstractExecutableComponentDescription.getName()

getDeveloperDescription

java.lang.String getDeveloperDescription()

Gets a description for the developer of the component and the administrator of the activity model.

Returns:

A description for the developer of the component and the administrator of the activity model.

See Also:

AbstractExecutableComponentDescription.getDeveloperDescription()

getRevision

long getRevision()

Gets the (base) revision of the executable component description of this reference which allows to track changes. In case of an executable component description of a production version the corresponding revision will be returned, for an executable component description of a development version this will be the base revision of the appropriate branch.

Returns:

The (base) revision of this executable component description which allows to track changes.

See Also:

AbstractExecutableComponentDescription.getRevision()

getState

State getState()

Gets the current deployment state of the component description 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 component description of this reference that implicitly also applies to all child entities.

See Also:

AbstractExecutableComponentDescription.getState()

getIconID

java.util.UUID getIconID()

Gets the ID of the icon to use for process steps and worklist items of the underlying executable component.

Returns:

The ID of the icon to use for process steps and worklist items.

See Also:

AbstractExecutableComponentDescription.getIconID()