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

All Superinterfaces:
ModelElement, ModelParticipantInfo, Participant, ParticipantInfo, org.eclipse.stardust.engine.api.model.QualifiedModelParticipantInfo, Serializable
All Known Subinterfaces:
ConditionalPerformer, Organization, Role

public interface ModelParticipant
extends Participant, org.eclipse.stardust.engine.api.model.QualifiedModelParticipantInfo, ModelElement

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

Version:
$Revision$
Author:
sborn

Field Summary
 
Fields inherited from interface org.eclipse.stardust.engine.api.model.ModelParticipantInfo
ADMINISTRATOR
 
Method Summary
 List<Organization> getAllSuperOrganizations()
          Returns the list of organizations this participant is part of.
 int getElementOID()
          Gets the OID of the model element.
 int getModelOID()
          Gets the OID of the model.
 String getNamespace()
          Gets the namespace of the model element.
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.Participant
getAllAttributes, getAttribute, getPartitionId, getPartitionOID
 
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.QualifiedModelParticipantInfo
getQualifiedId
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelParticipantInfo
definesDepartmentScope, getDepartment, getRuntimeElementOID, isDepartmentScoped
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.ParticipantInfo
getId, getName
 

Method Detail

getModelOID

int getModelOID()
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
Specified by:
getModelOID in interface Participant
Returns:
the OID of the model.
See Also:
ModelElement.getModelOID()

getElementOID

int getElementOID()
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
Specified by:
getElementOID in interface Participant
Returns:
the model element OID
See Also:
ModelElement.getElementOID()

getNamespace

String getNamespace()
Description copied from interface: ModelElement
Gets the namespace of the model element.

Specified by:
getNamespace in interface ModelElement
Specified by:
getNamespace in interface Participant
Returns:
the namespace (the Id of the containing model).
See Also:
ModelElement.getNamespace()

getAllSuperOrganizations

List<Organization> getAllSuperOrganizations()
Returns the list of organizations this participant is part of.

Specified by:
getAllSuperOrganizations in interface Participant
Returns:
A list of Organization instances.
See Also:
getAllSuperOrganizations()


Copyright © 2017 Eclipse Stardust. All Rights Reserved.