org.ow2.bonita.facade.def.majorElement.impl
Class ActivityDefinitionImpl

java.lang.Object
  extended by org.ow2.bonita.facade.def.majorElement.impl.NamedElementImpl
      extended by org.ow2.bonita.facade.def.majorElement.impl.ProcessElementImpl
          extended by org.ow2.bonita.facade.def.majorElement.impl.ActivityDefinitionImpl
All Implemented Interfaces:
java.io.Serializable, ActivityDefinition, NamedElement, ProcessElement

public class ActivityDefinitionImpl
extends ProcessElementImpl
implements ActivityDefinition

See Also:
Serialized Form

Nested Class Summary
static class ActivityDefinitionImpl.IterationDefinitionImpl
           
 
Nested classes/interfaces inherited from interface org.ow2.bonita.facade.def.majorElement.ActivityDefinition
ActivityDefinition.FinishMode, ActivityDefinition.IterationDef, ActivityDefinition.JoinType, ActivityDefinition.SplitType, ActivityDefinition.StartMode
 
Field Summary
protected  java.lang.String activityId
           
protected  MultiInstantiationDefinition activityInstantiator
           
protected  boolean asynchronous
           
protected  java.util.Set<DataFieldDefinition> dataFields
           
protected  java.util.Set<DeadlineDefinition> deadlines
           
protected  java.lang.String description
           
protected  ActivityDefinition.FinishMode finishMode
           
protected  java.util.Set<HookDefinition> hooks
           
protected  java.util.Set<ActivityDefinition.IterationDef> iterations
           
protected  ActivityDefinition.JoinType joinType
           
protected  boolean noImplementation
           
protected  java.lang.String performer
           
protected  PerformerAssignDefinition performerAssign
           
protected  boolean route
           
protected  ActivityDefinition.SplitType splitType
           
protected  ActivityDefinition.StartMode startMode
           
protected  SubFlowDefinition subFlow
           
protected  ActivityDefinitionUUID uuid
           
 
Fields inherited from class org.ow2.bonita.facade.def.majorElement.impl.ProcessElementImpl
processDefinitionUUID
 
Fields inherited from class org.ow2.bonita.facade.def.majorElement.impl.NamedElementImpl
name
 
Constructor Summary
protected ActivityDefinitionImpl()
           
  ActivityDefinitionImpl(ActivityDefinition src)
           
  ActivityDefinitionImpl(ActivityDefinitionUUID activityDefinitionUUID, java.lang.String activityId, ProcessDefinitionUUID processUUID, java.util.Set<DeadlineDefinition> deadlines, java.lang.String description, ActivityDefinition.FinishMode finishMode, java.lang.String name, java.lang.String performer, ActivityDefinition.StartMode startMode, SubFlowDefinition subFlow, boolean noImplementation, boolean route, java.util.Set<HookDefinition> hooks, PerformerAssignDefinition performerAssign, java.util.Set<DataFieldDefinition> dataFields, java.util.Set<ActivityDefinition.IterationDef> iterations, MultiInstantiationDefinition activityInstantiator, boolean asynchronous, ActivityDefinition.JoinType joinType, ActivityDefinition.SplitType splitType)
           
 
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 class org.ow2.bonita.facade.def.majorElement.impl.ProcessElementImpl
getProcessDefinitionUUID, setProcessDefinitionUUID
 
Methods inherited from class org.ow2.bonita.facade.def.majorElement.impl.NamedElementImpl
getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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
 

Field Detail

uuid

protected ActivityDefinitionUUID uuid

activityId

protected java.lang.String activityId

deadlines

protected java.util.Set<DeadlineDefinition> deadlines

description

protected java.lang.String description

finishMode

protected ActivityDefinition.FinishMode finishMode

performer

protected java.lang.String performer

startMode

protected ActivityDefinition.StartMode startMode

subFlow

protected SubFlowDefinition subFlow

joinType

protected ActivityDefinition.JoinType joinType

splitType

protected ActivityDefinition.SplitType splitType

noImplementation

protected boolean noImplementation

route

protected boolean route

hooks

protected java.util.Set<HookDefinition> hooks

performerAssign

protected PerformerAssignDefinition performerAssign

dataFields

protected java.util.Set<DataFieldDefinition> dataFields

iterations

protected java.util.Set<ActivityDefinition.IterationDef> iterations

activityInstantiator

protected MultiInstantiationDefinition activityInstantiator

asynchronous

protected boolean asynchronous
Constructor Detail

ActivityDefinitionImpl

protected ActivityDefinitionImpl()

ActivityDefinitionImpl

public ActivityDefinitionImpl(ActivityDefinitionUUID activityDefinitionUUID,
                              java.lang.String activityId,
                              ProcessDefinitionUUID processUUID,
                              java.util.Set<DeadlineDefinition> deadlines,
                              java.lang.String description,
                              ActivityDefinition.FinishMode finishMode,
                              java.lang.String name,
                              java.lang.String performer,
                              ActivityDefinition.StartMode startMode,
                              SubFlowDefinition subFlow,
                              boolean noImplementation,
                              boolean route,
                              java.util.Set<HookDefinition> hooks,
                              PerformerAssignDefinition performerAssign,
                              java.util.Set<DataFieldDefinition> dataFields,
                              java.util.Set<ActivityDefinition.IterationDef> iterations,
                              MultiInstantiationDefinition activityInstantiator,
                              boolean asynchronous,
                              ActivityDefinition.JoinType joinType,
                              ActivityDefinition.SplitType splitType)

ActivityDefinitionImpl

public ActivityDefinitionImpl(ActivityDefinition src)
Method Detail

getDeadlines

public java.util.Set<DeadlineDefinition> getDeadlines()
Description copied from interface: ActivityDefinition
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.

Specified by:
getDeadlines in interface ActivityDefinition

getDescription

public java.lang.String getDescription()
Description copied from interface: ActivityDefinition
Short textual description of the activity.

Specified by:
getDescription in interface ActivityDefinition

getFinishMode

public ActivityDefinition.FinishMode getFinishMode()
Description copied from interface: ActivityDefinition
Not supported.

Specified by:
getFinishMode in interface ActivityDefinition

getPerformer

public java.lang.String getPerformer()
Description copied from interface: ActivityDefinition
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.

Specified by:
getPerformer in interface ActivityDefinition

getStartMode

public ActivityDefinition.StartMode getStartMode()
Description copied from interface: ActivityDefinition
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

Specified by:
getStartMode in interface ActivityDefinition
Returns:
The StartMode enumeration value.

getSubFlow

public SubFlowDefinition getSubFlow()
Description copied from interface: ActivityDefinition
Returns the SubFlowDefinition interface if this activity has subflow implementation otherwise returns null.

Specified by:
getSubFlow in interface ActivityDefinition

isNoImplementation

public boolean isNoImplementation()
Description copied from interface: ActivityDefinition
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.

Specified by:
isNoImplementation in interface ActivityDefinition
Returns:
true if the No element is defined within the Implementation element otherwise false.

isRoute

public boolean isRoute()
Description copied from interface: ActivityDefinition
Activity can be defined either with Route or Implementation or BlockActivity element.

Specified by:
isRoute in interface ActivityDefinition
Returns:
true if the activity has been defined as a Route activity otherwise returns false.

getHooks

public java.util.Set<HookDefinition> getHooks()
Description copied from interface: ActivityDefinition
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.

Specified by:
getHooks in interface ActivityDefinition
Returns:
The (unordered) set of HookDefinition interfaces.

getPerformerAssign

public PerformerAssignDefinition getPerformerAssign()
Description copied from interface: ActivityDefinition
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:

Specified by:
getPerformerAssign in interface ActivityDefinition
Returns:
The PerformerAssignDefinition interface.

getDataFields

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

Specified by:
getDataFields in interface ActivityDefinition
Returns:
The (unordered) set of DataFieldDefinition interfaces.

getIterations

public java.util.Set<ActivityDefinition.IterationDef> getIterations()
Specified by:
getIterations in interface ActivityDefinition

getActivityId

public java.lang.String getActivityId()
Description copied from interface: ActivityDefinition
Returns the value of the id attribute of the Activity element defined into the XPDL file.

Specified by:
getActivityId in interface ActivityDefinition

getUUID

public ActivityDefinitionUUID getUUID()
Description copied from interface: ActivityDefinition
Returns the UUID for the ActivityDefinition.

Specified by:
getUUID in interface ActivityDefinition

getMultiInstantiationDefinition

public MultiInstantiationDefinition getMultiInstantiationDefinition()
Specified by:
getMultiInstantiationDefinition in interface ActivityDefinition

isAsynchronous

public boolean isAsynchronous()
Specified by:
isAsynchronous in interface ActivityDefinition

getJoinType

public ActivityDefinition.JoinType getJoinType()
Description copied from interface: ActivityDefinition
Returns Join Type definition.

Specified by:
getJoinType in interface ActivityDefinition

getSplitType

public ActivityDefinition.SplitType getSplitType()
Description copied from interface: ActivityDefinition
Returns Split Type definition.

Specified by:
getSplitType in interface ActivityDefinition

addData

public void addData(DataFieldDefinition data)
Specified by:
addData in interface ActivityDefinition

setDescription

public void setDescription(java.lang.String description)
Specified by:
setDescription in interface ActivityDefinition

setFilter

public void setFilter(PerformerAssignDefinition filter)
Specified by:
setFilter in interface ActivityDefinition

setMultiInstanciation

public void setMultiInstanciation(MultiInstantiationDefinition multiInstanciation)
Specified by:
setMultiInstanciation in interface ActivityDefinition

addDeadline

public void addDeadline(DeadlineDefinition deadline)
Specified by:
addDeadline in interface ActivityDefinition

addConnector

public void addConnector(HookDefinition connector)
Specified by:
addConnector in interface ActivityDefinition

setJoinType

public void setJoinType(ActivityDefinition.JoinType join)
Specified by:
setJoinType in interface ActivityDefinition

setSplitType

public void setSplitType(ActivityDefinition.SplitType split)
Specified by:
setSplitType in interface ActivityDefinition

addIteration

public void addIteration(ActivityDefinition.IterationDef iteration)
Specified by:
addIteration in interface ActivityDefinition

setAsynchronous

public void setAsynchronous(boolean asynchronous)
Specified by:
setAsynchronous in interface ActivityDefinition

setUUID

public void setUUID(ActivityDefinitionUUID uuid)
Specified by:
setUUID in interface ActivityDefinition


Copyright © 2009 OW2 Consortium. All Rights Reserved.