org.ow2.bonita.facade.runtime
Interface TaskInstance

All Superinterfaces:
ActivityBody, java.io.Serializable
All Known Subinterfaces:
TaskFullInstance
All Known Implementing Classes:
TaskFullInstanceImpl, TaskInstanceImpl

public interface TaskInstance
extends ActivityBody, java.io.Serializable

Interface for the body of task activity (aka Manual activity).


Method Summary
 java.util.List<AssignUpdate> getAssignUpdates()
          Returns the list of recorded assign changes.
 java.util.Date getCreatedDate()
          Returns the date recorded when the task is created.
 java.util.Date getDueDate()
          Returns the date at which the task must be started.
 java.lang.String getEndedBy()
          Returns the user finishing the activity.
 java.lang.String getStartedBy()
          Returns the user starting the task.
 java.util.Set<java.lang.String> getTaskCandidates()
          Returns the current set of candidate users.
This list depends on:
the set of candidate users when the task has been initially created.
 java.lang.String getTaskUser()
          Returns the user assigned for the task.
Check before calling this method if a user has been assigned with isTaskAssigned() method.
 java.lang.String getUpdatedBy()
          Returns the user Id performing the update (state update or assign update).
 TaskUUID getUUID()
          Returns the UUID of the task.
 boolean isTaskAssigned()
          Return true if the task is assigned.
 
Methods inherited from interface org.ow2.bonita.facade.runtime.ActivityBody
copy, getEndedDate, getReadyDate, getStartedDate, getState, getStateUpdates
 

Method Detail

getTaskCandidates

java.util.Set<java.lang.String> getTaskCandidates()
Returns the current set of candidate users.
This list depends on:

Returns:
A set of user id.

getTaskUser

java.lang.String getTaskUser()
Returns the user assigned for the task.
Check before calling this method if a user has been assigned with isTaskAssigned() method. The assigned user depends on:

Returns:
The user assigned for the task.
Throws:
java.lang.IllegalStateException - if the task is not assigned.

getUpdatedBy

java.lang.String getUpdatedBy()
Returns the user Id performing the update (state update or assign update).

Returns:
the user Id performing the update (state update or assign update).

getStartedBy

java.lang.String getStartedBy()
Returns the user starting the task.

Returns:
The user starting the task.

getEndedBy

java.lang.String getEndedBy()
Returns the user finishing the activity.

Returns:
The user finishing the activity.

getCreatedDate

java.util.Date getCreatedDate()
Returns the date recorded when the task is created. The task is created when the execution flow enters into the activity node defining the task.

Returns:
The date recorded when the task is created.

getDueDate

java.util.Date getDueDate()
Returns the date at which the task must be started.

Returns:
The date at which the task must be started.

getAssignUpdates

java.util.List<AssignUpdate> getAssignUpdates()
Returns the list of recorded assign changes.

Returns:
The list of recorded assign changes.

getUUID

TaskUUID getUUID()
Returns the UUID of the task.

Specified by:
getUUID in interface ActivityBody
Returns:
The UUID of the task.

isTaskAssigned

boolean isTaskAssigned()
Return true if the task is assigned.

Returns:
true if the task is assigned.


Copyright © 2009 OW2 Consortium. All Rights Reserved.