org.eclipse.stardust.engine.api.model

Interface Model

All Superinterfaces:

ModelElement, Serializable

All Known Subinterfaces:

DeployedModel

public interface Model
extends ModelElement

A client side view of a workflow model. Contains information about the model as well as sub elements such as processes, roles, organisations etc.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Methods

Modifier and Type	Method and Description
List	getAllData() Gets all the data definitions contained in this model.
List	getAllOrganizations() Gets all the organizations defined in this model.
List	getAllParticipants() Gets all participants defined in this model.
List	getAllProcessDefinitions() Gets all the process definitions contained in this model.
Set<QualityAssuranceCode>	getAllQualityAssuranceCodes()
List	getAllRoles() Gets all the roles defined in this model.
List	getAllTopLevelOrganizations() Gets all the top level organizations defined in this model.
List	getAllTopLevelRoles() Gets all the top level roles defined in this model.
List<TypeDeclaration>	getAllTypeDeclarations() Gets all the type declarations contained in this model.
Data	getData(String id) Gets the specified data definition.
Set<String>	getExternalPackages() Gets the referenced external package ids.
Organization	getOrganization(String id) Gets the specified organization.
Participant	getParticipant(String id) Gets the specified participant.
ProcessDefinition	getProcessDefinition(String id) Gets the specified process definition.
Long	getResolvedModelOid(String externalPackageId) Gets the resolved model oid corresponding to the external package reference.
Role	getRole(String id) Gets the specified role.
TypeDeclaration	getTypeDeclaration(DocumentType documentType) Gets the specified type declaration.
TypeDeclaration	getTypeDeclaration(String id) Gets the specified type declaration.

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

getAllAttributes, getAttribute, getDescription, getElementOID, getId, getModelOID, getName, getNamespace, getPartitionId, getPartitionOID, getQualifiedId

Method Detail

getAllQualityAssuranceCodes

Set<QualityAssuranceCode> getAllQualityAssuranceCodes()

getAllParticipants

List getAllParticipants()

Gets all participants defined in this model.

Returns:

a List of Participant objects.

getParticipant

Participant getParticipant(String id)

Gets the specified participant.

Parameters:

id - the ID of the participant.

Returns:

the participand having the provided id or null if no participant was found.

getAllOrganizations

List getAllOrganizations()

Gets all the organizations defined in this model.

Returns:

a List of Organization objects.

getOrganization

Organization getOrganization(String id)

Gets the specified organization.

Parameters:

id - the ID of the organization.

Returns:

the organization having the provided id or null if no organization was found.

getAllRoles

List getAllRoles()

Gets all the roles defined in this model.

Returns:

a List of Role objects.

getRole

Role getRole(String id)

Gets the specified role.

Parameters:

id - the ID of the role.

Returns:

the role having the provided id or null if no role was found.

getAllTopLevelOrganizations

List getAllTopLevelOrganizations()

Gets all the top level organizations defined in this model. A top level organization is an organization which is not a part of any other organization.

Returns:

a List of Organization objects.

getAllTopLevelRoles

List getAllTopLevelRoles()

Gets all the top level roles defined in this model. A top level role is a role which is not part of any organization.

Returns:

a List of Role objects.

getAllProcessDefinitions

List getAllProcessDefinitions()

Gets all the process definitions contained in this model.

Returns:

a List of ProcessDefinition objects.

getProcessDefinition

ProcessDefinition getProcessDefinition(String id)

Gets the specified process definition.

Parameters:

id - the ID of the process definition.

Returns:

the process definition having the provided id or null if no process definition was found.

getAllData

List getAllData()

Gets all the data definitions contained in this model.

Returns:

a List of Data objects.

getData

Data getData(String id)

Gets the specified data definition.

Parameters:

id - the ID of the data definition

Returns:

the data definition having the provided id or null if no data definition was found.

getAllTypeDeclarations

List<TypeDeclaration> getAllTypeDeclarations()

Gets all the type declarations contained in this model.

Returns:

a List of TypeDeclaration objects.

getTypeDeclaration

TypeDeclaration getTypeDeclaration(String id)

Gets the specified type declaration.

Parameters:

id - the ID of the type declaration

Returns:

the type declaration having the provided id or null if no type declaration was found.

getTypeDeclaration

TypeDeclaration getTypeDeclaration(DocumentType documentType)

Gets the specified type declaration.

Parameters:

documentType - the documentType of a Document.

Returns:

the type declaration matching the provided documentType or null if no type declaration was found.

getExternalPackages

Set<String> getExternalPackages()

Gets the referenced external package ids.

Returns:

a collection of ids.

getResolvedModelOid

Long getResolvedModelOid(String externalPackageId)

Gets the resolved model oid corresponding to the external package reference.

Parameters:

externalPackageId - the id of the external package reference.

Returns:

the oid of the resolved model or null if the id does not correspond to an external package reference.