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

All Superinterfaces:
DefinitionRecord, ProcessDefinitionRecord, java.io.Serializable

public interface ActivityDefinition
extends ProcessDefinitionRecord, 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.StartMode
          StartMode parameter determines whether the activity is automatically started by the engine or not.
 
Method Summary
 java.lang.String getActivityId()
          Returns the value of the id attribute of the Activity element defined into the XPDL file.
 java.lang.String getBlockId()
          Not supported.
 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.
 java.lang.String getDocumentation()
          The address (e.g. path- and filename) for a help file or a description file 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.
 java.lang.String getIcon()
          Address (path- and filename) for an icon to represent the activity in a graphical modeller.
 java.util.Set<ActivityDefinition.IterationDef> getIterations()
           
 java.lang.String getLimit()
          Expected duration for time management purposes (e.g. starting an escalation procedure etc.)
 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.
 java.lang.String getPriority()
          A value that describes the initial priority of this activity when it starts execution.
 SimulationInformationDefinition getSimulationInformation()
          Estimations for simulation of an Activity.
 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.
 SubFlowDefinition getSubFlow()
          Returns the SubFlowDefinition interface if this activity has subflow implementation otherwise returns null.
 java.util.Set<ToolDefinition> getTools()
          Returns (unordered) set of ToolDefinition interfaces.
 java.util.Set<TransitionRestrictionDefinition> getTransitionRestrictions()
          Gives the routing behavior if outgoing transitions or/and incoming transitions are defined.
 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.
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.ProcessDefinitionRecord
getProcessDefinitionUUID
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.DefinitionRecord
getName, getPackageDefinitionUUID
 

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.


getLimit

java.lang.String getLimit()
Expected duration for time management purposes (e.g. starting an escalation procedure etc.) inunits of DurationUnit. It is counted from the starting date/time of the Process. The consequences of reaching the limit value is depending on the engine.
This is not yet supported.


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.


getTools

java.util.Set<ToolDefinition> getTools()
Returns (unordered) set of ToolDefinition interfaces. Returns an empty set if no tools implementations are defined.


getBlockId

java.lang.String getBlockId()
Not supported.


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.


getPriority

java.lang.String getPriority()
A value that describes the initial priority of this activity when it starts execution. If this attribute is not defined but a priority is defined in the Process definition then that is used.
By default it is assumed that the priority levels are the natural numbers starting with zero, and that the higher the value the higher the priority (i.e.: 0,...., n).
Not yet 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.


getSimulationInformation

SimulationInformationDefinition getSimulationInformation()
Estimations for simulation of an Activity. No default. Not supported.


getIcon

java.lang.String getIcon()
Address (path- and filename) for an icon to represent the activity in a graphical modeller. May be used to override the modeller icon for an activity.


getDocumentation

java.lang.String getDocumentation()
The address (e.g. path- and filename) for a help file or a description file of the activity.


getTransitionRestrictions

java.util.Set<TransitionRestrictionDefinition> getTransitionRestrictions()
Gives the routing behavior if outgoing transitions or/and incoming transitions are defined. Two types of transition element exist: SPLIT and JOIN.

Returns:
The (unordered) set of TransitionRestrictionDefinition interfaces.

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()

isAsynchronous

boolean isAsynchronous()


Copyright © 2009 OW2 Consortium. All Rights Reserved.