org.ow2.bonita.facade.def.majorElement
Interface ProcessDefinition

All Superinterfaces:

DescriptionElement, LightProcessDefinition, NamedElement, java.io.Serializable

All Known Implementing Classes:

ProcessDefinitionImpl

public interface ProcessDefinition
extends LightProcessDefinition

This interface represents the Process definition. It's derived from the WorkflowProcess of XPDL.

Nested Class Summary

static class

ProcessDefinition.ProcessState Process state are used to define the process life cycle. A process can be enable, disable several times.

Method Summary

java.util.Set<ActivityDefinition>	getActivities() Gets the process activities.
ActivityDefinition	getActivity(java.lang.String name) Returns the activity with the given name.
java.lang.String	getAMetaData(java.lang.String key) Gets a meta-data of the process according to its key.
AttachmentDefinition	getAttachment(java.lang.String name) Gets an attachment of the process according to its name
java.util.Map<java.lang.String,AttachmentDefinition>	getAttachments() Gets the attachments of the process
java.util.Set<java.lang.String>	getClassDependencies() Returns class dependencies (java classes used by connectors).
java.util.List<HookDefinition>	getConnectors() Obtains process connectors.
DataFieldDefinition	getDatafield(java.lang.String name) Gets a dataField according to its name
java.util.Set<DataFieldDefinition>	getDataFields() Gets process dataFields.
java.util.Map<java.lang.String,ActivityDefinition>	getFinalActivities() Gets the final activities.
java.util.Map<java.lang.String,ActivityDefinition>	getInitialActivities() Gets the initial activities.
java.util.Set<IterationDescriptor>	getIterationDescriptors() Gets the iteration descriptors.
java.util.Set<IterationDescriptor>	getIterationDescriptors(java.lang.String activityName) Gets iteration descriptors according to the activity name
java.util.Map<java.lang.String,java.lang.String>	getMetaData() Gets all meta-data of the process.
java.util.Set<ParticipantDefinition>	getParticipants() Gets the participants of the process.
java.util.Set<java.lang.String>	getProcessDependencies() Gets the process dependencies (sub-processes) of this process. Note: If a sub-process of this process is defined in another process, it is not possible to undeploy these sub-processes until this process is undeployed.
java.util.Set<java.lang.String>	getSubProcesses() Gets the process sub-processes.
java.util.Set<TransitionDefinition>	getTransitions() Gets the process transitions.

Methods inherited from interface org.ow2.bonita.light.LightProcessDefinition

getDeployedBy, getDeployedDate, getState, getUndeployedBy, getUndeployedDate, getUUID, getVersion

Methods inherited from interface org.ow2.bonita.facade.def.majorElement.NamedElement

getLabel, getName

Methods inherited from interface org.ow2.bonita.facade.def.majorElement.DescriptionElement

getDescription

Method Detail

getMetaData

java.util.Map<java.lang.String,java.lang.String> getMetaData()

Gets all meta-data of the process.

Returns:

all meta-data of the process

getAMetaData

java.lang.String getAMetaData(java.lang.String key)

Gets a meta-data of the process according to its key.

Parameters:

key - the key of the meta-data

Returns:

the meta-data

getAttachments

java.util.Map<java.lang.String,AttachmentDefinition> getAttachments()

Gets the attachments of the process

Returns:

the attachments of the process

getAttachment

AttachmentDefinition getAttachment(java.lang.String name)

Gets an attachment of the process according to its name

Parameters:

name - the attachment name

Returns:

an attachment of the process

getConnectors

java.util.List<HookDefinition> getConnectors()

Obtains process connectors.

Returns:

the process connector list

getDataFields

java.util.Set<DataFieldDefinition> getDataFields()

Gets process dataFields.

Returns:

the process dataFields.

getParticipants

java.util.Set<ParticipantDefinition> getParticipants()

Gets the participants of the process.

Returns:

the participant list

getActivities

java.util.Set<ActivityDefinition> getActivities()

Gets the process activities.

Returns:

the process activities.

getTransitions

java.util.Set<TransitionDefinition> getTransitions()

Gets the process transitions.

Returns:

the process transitions

getSubProcesses

java.util.Set<java.lang.String> getSubProcesses()

Gets the process sub-processes.

Returns:

the process sub-processes

getProcessDependencies

java.util.Set<java.lang.String> getProcessDependencies()

Gets the process dependencies (sub-processes) of this process.
Note: If a sub-process of this process is defined in another process, it is not possible to undeploy these sub-processes until this process is undeployed.

Returns:

The set of processDefinitionUUID depending on this process definition.

getClassDependencies

java.util.Set<java.lang.String> getClassDependencies()

Returns class dependencies (java classes used by connectors).

Returns:

the class names which connectors of this process depend.

getActivity

ActivityDefinition getActivity(java.lang.String name)

Returns the activity with the given name. Null if no activity exists within the process with the given name.

Parameters:

name - the activity name

Returns:

the activity

getDatafield

DataFieldDefinition getDatafield(java.lang.String name)

Gets a dataField according to its name

Parameters:

name - the dataField name

Returns:

the dataField

getInitialActivities

java.util.Map<java.lang.String,ActivityDefinition> getInitialActivities()

Gets the initial activities.

Returns:

the initial activities

getFinalActivities

java.util.Map<java.lang.String,ActivityDefinition> getFinalActivities()

Gets the final activities.

Returns:

the final activities

getIterationDescriptors

java.util.Set<IterationDescriptor> getIterationDescriptors()

Gets the iteration descriptors.

Returns:

the iteration descriptors

getIterationDescriptors

java.util.Set<IterationDescriptor> getIterationDescriptors(java.lang.String activityName)

Gets iteration descriptors according to the activity name

Parameters:

activityName - the activity name

Returns:

the iteration descriptors of an activity