de.aristaflow.adept2.model.processmodel

Interface DataElement

All Superinterfaces:

LocalisedString, PluginDataContainer, UserAttributeContainer

public interface DataElement
extends UserAttributeContainer, PluginDataContainer, LocalisedString

The DataElement interface offers access to the data elements of a process. The adept model arranges that they are connected to nodes using data edges. The interfaces abstract this: Node and DataElement have direct references to each other. Executable business processes (i.e. activities and subprocesses) got a mapping to and from data elements and parameters.

See Also:

ExecutableBusinessProcess

Method Summary

Modifier and Type	Method and Description
ProcessConstants.AdeptDataType	getDataType() Returns the type of the data element as byte constant.
java.lang.String	getDescription() Returns a description of the data element.
java.util.UUID	getIconID() Gets the ID of the icon to use for displaying this data element in a template view.
int	getID() Returns the ID of the data element.
java.util.UUID	getIdentifierID() Returns the ID of the common identifier, which represents the type of the element in detail.
java.lang.String	getName() Returns the name of the data element.
java.lang.String	getUDTName() In case the type of the data element is "user-defined", this function returns a string which specifies type.
boolean	isPublic() Returns true, if the data which is stored in the data element during runtime, may be accessed by all agents.
boolean	isVirtual() Returns true if this is a virtual parameter.

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

Methods inherited from interface de.aristaflow.adept2.model.common.i18n.LocalisedString

toLocalisedString

Method Detail

getID

int getID()

Returns the ID of the data element. This id is unique within the process.

Returns:

The ID of the data element.

getName

java.lang.String getName()

Returns the name of the data element.

Returns:

The name of the data element.

getDataType

ProcessConstants.AdeptDataType getDataType()

Returns the type of the data element as byte constant.

Returns:

The type as byte constant.

getUDTName

java.lang.String getUDTName()

In case the type of the data element is "user-defined", this function returns a string which specifies type.

Returns:

The user defined type.

getDescription

java.lang.String getDescription()

Returns a description of the data element.

Returns:

A description of the data element.

getIconID

java.util.UUID getIconID()

Gets the ID of the icon to use for displaying this data element in a template view. With the ID the corresponding item can be requested from an icon providing service in various sizes and formats.

Returns:

The ID of the icon to use for displaying this data element in a template view; the corresponding icon may be retrieved in various sizes and formats. This may be null if no icon is specified.

getIdentifierID

java.util.UUID getIdentifierID()

Returns the ID of the common identifier, which represents the type of the element in detail. Refer to Identifier for further information.

Returns:

The ID of the identifier.

isVirtual

boolean isVirtual()

Returns true if this is a virtual parameter.

Returns:

True if the parameter is virtual.

isPublic

boolean isPublic()

Returns true, if the data which is stored in the data element during runtime, may be accessed by all agents. These data elements may e.g. be used for filtering worklist entries, even though the worklist entry does not require access to the data element.

Returns:

True, if the data element is public.