org.eclipse.stardust.engine.api.model
Interface ModelElement

All Superinterfaces:
Serializable
All Known Subinterfaces:
Activity, Application, ApplicationContext, ConditionalPerformer, Data, DataMapping, DataPath, DeployedModel, DeployedModelDescription, DynamicParticipant, EventAction, EventHandler, Model, ModelParticipant, Organization, ParameterMapping, Participant, ProcessDefinition, Role, Trigger, TypeDeclaration, User, UserGroup

public interface ModelElement
extends Serializable

A client side view of a model element.

Model elements are workflow relevant objects that are created during workflow modelling and which have a representation in the CARNOT runtime after model deployment. Model elements have a persistent representation in the audit trail database by being part of a deployed model stored in the MODEL table of the audit trail database.

Client side views of CARNOT model elements are exposed to a client as readonly detail objects which contain a copy of the state of the corresponding server object.

Version:
$Revision$
Author:
ubirkemeyer

Method Summary
 Map getAllAttributes()
          Gets all the attributes defined for this model element.
 Object getAttribute(String name)
          Gets a specified attribute.
 String getDescription()
          Gets the (optional) description of this model element.
 int getElementOID()
          Gets the OID of the model element.
 String getId()
          Gets the ID of this model element.
 int getModelOID()
          Gets the OID of the model.
 String getName()
          Gets the name of this model element.
 String getNamespace()
          Gets the namespace of the model element.
 String getPartitionId()
          Provides the ID of the partition this model element is deploed to.
 short getPartitionOID()
          Provides the OID of the partition this model element is deployed to.
 String getQualifiedId()
          Gets the qualified ID of the model element.
 

Method Detail

getPartitionOID

short getPartitionOID()
Provides the OID of the partition this model element is deployed to.

Returns:
The partition OID.

getPartitionId

String getPartitionId()
Provides the ID of the partition this model element is deploed to.

Returns:
The partition ID.

getId

String getId()
Gets the ID of this model element.

Model elements such as process definitions or roles are identified by their ID. The IDs of model elements are Strings being unique inside the containing scope of the model element and the model version. The meaning of containing scope can vary for different model element types, but is usually given by the corresponding factory method.

Returns:
the ID of the model element.

getDescription

String getDescription()
Gets the (optional) description of this model element.

Returns:
the description of the model element.

getName

String getName()
Gets the name of this model element.

Model elements have names which can be used to identify them in visual user interfaces.

Returns:
the name of the model element.

getModelOID

int getModelOID()
Gets the OID of the model.

The model OID is used to identify the model defining that model element in the scope of the CARNOT runtime.

Returns:
the OID of the model.
See Also:
getElementOID()

getElementOID

int getElementOID()
Gets the OID of the model element.

Each model element has a unique OID in the scope of the defining model.

Returns:
the model element OID
See Also:
getModelOID()

getAllAttributes

Map getAllAttributes()
Gets all the attributes defined for this model element.

Returns:
a Map with name-value pairs containing the attributes defined at modelling time.

getAttribute

Object getAttribute(String name)
Gets a specified attribute.

Parameters:
name - the name of the attribute.
Returns:
the value of the attribute.

getNamespace

String getNamespace()
Gets the namespace of the model element.

Returns:
the namespace (the Id of the containing model).

getQualifiedId

String getQualifiedId()
Gets the qualified ID of the model element.

Returns:
the qualified id in the form "{}"


Copyright © 2017 Eclipse Stardust. All Rights Reserved.