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

All Superinterfaces:
NamedElement, ProcessElement, java.io.Serializable
All Known Implementing Classes:
ActivityDefinitionImpl

public interface ActivityDefinition
extends ProcessElement, java.io.Serializable

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


Nested Class Summary
static class ActivityDefinition.FinishMode
          Not supported (because XPDL is not clear enough for this parameter).
static interface ActivityDefinition.IterationDef
          Interface for Iteration definition.
static class ActivityDefinition.JoinType
          Join types supported by Bonita.
static class ActivityDefinition.SplitType
          Split types supported by Bonita.
static class ActivityDefinition.StartMode
          StartMode parameter determines whether the activity is automatically started by the engine or not.
 
Method Summary
 void addConnector(HookDefinition connector)
           
 void addData(DataFieldDefinition data)
           
 void addDeadline(DeadlineDefinition deadline)
           
 void addIteration(ActivityDefinition.IterationDef iteration)
           
 java.lang.String getActivityId()
          Returns the value of the id attribute of the Activity element defined into the XPDL file.
 java.util.Set<DataFieldDefinition> getDataFields()
          Bonita engine allows to specify datafields for activities.
 java.util.Set<DeadlineDefinition> getDeadlines()
          Deadlines are used to execute a specified java class upon the expiration of a specified period of time.
 java.lang.String getDescription()
          Short textual description of the activity.
 ActivityDefinition.FinishMode getFinishMode()
          Not supported.
 java.util.Set<HookDefinition> getHooks()
          Hooks are user defined logic that can be triggered at some points of the life of the activity.
Those points are: taskOnReady taskOnStart taskOnFinish
If the activity has startMode=Manual then these points of the life of the activity is synchronized with ones of the task.
 java.util.Set<ActivityDefinition.IterationDef> getIterations()
           
 ActivityDefinition.JoinType getJoinType()
          Returns Join Type definition.
 MultiInstantiationDefinition getMultiInstantiationDefinition()
           
 java.lang.String getPerformer()
          Returns the performer of the activity.
 PerformerAssignDefinition getPerformerAssign()
          Performer assignment allows to perform various assignment rules within the task module.
All the users defined into the role type can see and execute this one.
 ActivityDefinition.SplitType getSplitType()
          Returns Split Type definition.
 ActivityDefinition.StartMode getStartMode()
          If StartMode=Manual a task entity is created by the engine and stored in the task repository and is waiting to be take in account by an end user.
If StartMode=Automatic no task is created.
 SubFlowDefinition getSubFlow()
          Returns the SubFlowDefinition interface if this activity has subflow implementation otherwise returns null.
 ActivityDefinitionUUID getUUID()
          Returns the UUID for the ActivityDefinition.
 boolean isAsynchronous()
           
 boolean isNoImplementation()
          Activity can be defined either with Route or Implementation or BlockActivity element.
 boolean isRoute()
          Activity can be defined either with Route or Implementation or BlockActivity element.
 void setAsynchronous(boolean asynchronous)
           
 void setDescription(java.lang.String description)
           
 void setFilter(PerformerAssignDefinition filter)
           
 void setJoinType(ActivityDefinition.JoinType join)
           
 void setMultiInstanciation(MultiInstantiationDefinition multiInstanciation)
           
 void setSplitType(ActivityDefinition.SplitType split)
           
 void setUUID(ActivityDefinitionUUID uuid)
           
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.ProcessElement
getProcessDefinitionUUID, setProcessDefinitionUUID
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.NamedElement
getName
 

Method Detail

getUUID

ActivityDefinitionUUID getUUID()
Returns the UUID for the ActivityDefinition.


getActivityId

java.lang.String getActivityId()
Returns the value of the id attribute of the Activity element defined into the XPDL file.


getDescription

java.lang.String getDescription()
Short textual description of the activity.


isRoute

boolean isRoute()
Activity can be defined either with Route or Implementation or BlockActivity element.

Returns:
true if the activity has been defined as a Route activity otherwise returns false.

isNoImplementation

boolean isNoImplementation()
Activity can be defined either with Route or Implementation or BlockActivity element. In case activity has been defined with an Implementation element, its child element could be either No or Tool or SubFlow element.

Returns:
true if the No element is defined within the Implementation element otherwise false.

getSubFlow

SubFlowDefinition getSubFlow()
Returns the SubFlowDefinition interface if this activity has subflow implementation otherwise returns null.


getPerformer

java.lang.String getPerformer()
Returns the performer of the activity. For an activity with startMode=Manual the performer element contains a defined participant processDefinitionUUID. For an activity with startMode=Automatic the performer element contains the generic participant SYSTEM.


getStartMode

ActivityDefinition.StartMode getStartMode()
If StartMode=Manual a task entity is created by the engine and stored in the task repository and is waiting to be take in account by an end user.
If StartMode=Automatic no task is created. the activity is automatically performed

Returns:
The StartMode enumeration value.

getFinishMode

ActivityDefinition.FinishMode getFinishMode()
Not supported.


getDeadlines

java.util.Set<DeadlineDefinition> getDeadlines()
Deadlines are used to execute a specified java class upon the expiration of a specified period of time. returns (unordered) set of Deadlines. returns empty set if no deadline are defined within the activity.


getDataFields

java.util.Set<DataFieldDefinition> getDataFields()
Bonita engine allows to specify datafields for activities. As xpdl v1 does not allow this definition, extended attributes are specified for this purpose.

Returns:
The (unordered) set of DataFieldDefinition interfaces.

getHooks

java.util.Set<HookDefinition> getHooks()
Hooks are user defined logic that can be triggered at some points of the life of the activity.
Those points are:
If the activity has startMode=Manual then these points of the life of the activity is synchronized with ones of the task.

Returns:
The (unordered) set of HookDefinition interfaces.

getPerformerAssign

PerformerAssignDefinition getPerformerAssign()
Performer assignment allows to perform various assignment rules within the task module.
All the users defined into the role type can see and execute this one. By adding this functionality, we can:

Returns:
The PerformerAssignDefinition interface.

getIterations

java.util.Set<ActivityDefinition.IterationDef> getIterations()

getMultiInstantiationDefinition

MultiInstantiationDefinition getMultiInstantiationDefinition()

getJoinType

ActivityDefinition.JoinType getJoinType()
Returns Join Type definition.


getSplitType

ActivityDefinition.SplitType getSplitType()
Returns Split Type definition.


isAsynchronous

boolean isAsynchronous()

setUUID

void setUUID(ActivityDefinitionUUID uuid)

setAsynchronous

void setAsynchronous(boolean asynchronous)

addIteration

void addIteration(ActivityDefinition.IterationDef iteration)

setSplitType

void setSplitType(ActivityDefinition.SplitType split)

setJoinType

void setJoinType(ActivityDefinition.JoinType join)

setDescription

void setDescription(java.lang.String description)

setFilter

void setFilter(PerformerAssignDefinition filter)

setMultiInstanciation

void setMultiInstanciation(MultiInstantiationDefinition multiInstanciation)

addDeadline

void addDeadline(DeadlineDefinition deadline)

addConnector

void addConnector(HookDefinition connector)

addData

void addData(DataFieldDefinition data)


Copyright © 2009 OW2 Consortium. All Rights Reserved.