org.ow2.bonita.facade.runtime
Interface TaskInstance

All Superinterfaces:
ActivityBody, java.io.Serializable
All Known Subinterfaces:
TaskFullInstance

public interface TaskInstance
extends ActivityBody, java.io.Serializable

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


Method Summary
 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.util.Set<java.lang.String> getInitialTaskCandidates()
          Returns the set of candidate users when the task has been initially created.
 java.lang.String getInitialTaskUser()
          Returns the user assigned for the task when the task has been initially created.
 java.lang.String getStartedBy()
          Returns the user starting the task.
 TaskState getState()
          Returns the current state.
 java.util.Set<java.lang.String> getTaskCandidates()
          Returns the current set of candidate users.
 java.lang.String getTaskUser()
          Returns the user assigned for the task.
 java.lang.String getUpdatedBy()
          Returns the user Id performing the update (state update or assign update).
 java.util.List<Update> getUpdates()
          Returns the list of recorded state changes.
 TaskUUID getUUID()
          Returns the UUID of the task.
 boolean isTaskAssigned()
          Return true if the task is assigned.
 boolean isTaskInitiallyAssigned()
          Returns true if the task has been assigned when the task has been initially created.
 
Methods inherited from interface org.ow2.bonita.facade.runtime.ActivityBody
copy, getEndedDate, getStartedDate
 

Method Detail

getInitialTaskCandidates

java.util.Set<java.lang.String> getInitialTaskCandidates()
Returns the set of candidate users when the task has been initially created.
This list depends on the type of performer and the optional role mapper that has been defined for the activity.

Returns:
A set of user id.

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.
Throws:
java.lang.IllegalStateException - if candidates list has not

getInitialTaskUser

java.lang.String getInitialTaskUser()
Returns the user assigned for the task when the task has been initially created.
Check before calling this method if a user has been initially assigned with isTaskInitiallyAssigned() method.

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

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.

getUpdates

java.util.List<Update> getUpdates()
Returns the list of recorded state changes.

Returns:
The list of recorded state changes.

getUUID

TaskUUID getUUID()
Returns the UUID of the task.

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

getState

TaskState getState()
Returns the current state.

Returns:
The current state.

isTaskInitiallyAssigned

boolean isTaskInitiallyAssigned()
Returns true if the task has been assigned when the task has been initially created.

Returns:
true if the task has been assigned when the task has been initially created.

isTaskAssigned

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

Returns:
true if the task is assigned.


Copyright © 2008 OW2 Consortium. All Rights Reserved.