org.eclipse.stardust.engine.api.model

Interface Participant

All Superinterfaces:

ModelElement, ParticipantInfo, Serializable

All Known Subinterfaces:

ConditionalPerformer, DynamicParticipant, ModelParticipant, Organization, Role, User, UserGroup

public interface Participant
extends ModelElement, ParticipantInfo

A client side view of a workflow participant. A participant is a workflow element which performs manual or interactive activities.

Starting with the introduction of user groups, workflow participants are not necessarily model elements anymore. Due to this fact the generalization association between ModelElement and Participant is deprecated. Participants which are defined at modelling time are now implementations of ModelParticipant instead.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Methods

Modifier and Type	Method and Description
Map	getAllAttributes() Returns all custom attributes of this participant.
List	getAllSuperOrganizations() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of Collections.EMPTY_LIST.
Object	getAttribute(String name) Returns a specific custom attribute of this participant.
int	getElementOID() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.
int	getModelOID() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.
String	getNamespace() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of null.
String	getPartitionId() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of null.
short	getPartitionOID() Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.

Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement

getDescription, getId, getName, getQualifiedId

Methods inherited from interface org.eclipse.stardust.engine.api.model.ParticipantInfo

getId, getName, getQualifiedId

Method Detail

getAllAttributes

Map getAllAttributes()

Returns all custom attributes of this participant.

Specified by:

getAllAttributes in interface ModelElement

Returns:

A Map with name-value pairs containing all custom attributes defined for this participant.

getAttribute

Object getAttribute(String name)

Returns a specific custom attribute of this participant.

Specified by:

getAttribute in interface ModelElement

Parameters:

name - The name of the attribute to be returned.

Returns:

The attribute value.

getPartitionOID

short getPartitionOID()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.

Description copied from interface: ModelElement

Provides the OID of the partition this model element is deployed to.

Specified by:

getPartitionOID in interface ModelElement

Returns:

The partition OID.

See Also:

ModelParticipant.getModelOID()

getPartitionId

String getPartitionId()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of null.

Description copied from interface: ModelElement

Provides the ID of the partition this model element is deploed to.

Specified by:

getPartitionId in interface ModelElement

Returns:

The partition ID.

See Also:

ModelParticipant.getModelOID()

getModelOID

int getModelOID()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.

Description copied from interface: ModelElement

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.

Specified by:

getModelOID in interface ModelElement

Returns:

the OID of the model.

See Also:

ModelParticipant.getModelOID()

getElementOID

int getElementOID()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of 0.

Description copied from interface: ModelElement

Gets the OID of the model element.

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

Specified by:

getElementOID in interface ModelElement

Returns:

the model element OID

See Also:

ModelParticipant.getElementOID()

getAllSuperOrganizations

List getAllSuperOrganizations()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of Collections.EMPTY_LIST.

See Also:

ModelParticipant.getAllSuperOrganizations()

getNamespace

String getNamespace()

Deprecated. The inheritance association between ModelElement and Participant is deprecated. Participants which are defined in a workflow model are now implementations of ModelParticipant. Invoking this method on a non-model participant will result in a value of null.

Description copied from interface: ModelElement

Gets the namespace of the model element.

Specified by:

getNamespace in interface ModelElement

Returns:

the namespace (the Id of the containing model).

See Also:

ModelParticipant.getNamespace()