org.ow2.bonita.facade.runtime
Interface TaskInst

All Superinterfaces:
Record, RuntimeRecord, java.io.Serializable

public interface TaskInst
extends RuntimeRecord

Author:
Guillaume Porcher

Method Summary
 java.lang.String getActivityId()
          Returns the activity id for which the task is attached.
 java.util.Set<java.lang.String> getCandidates()
          Returns the set of users that has been set to the candidates list.
 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.util.Date getEndedDate()
          Returns the date recorded when the task is finished.
 java.lang.String getSignal()
          The signal is used to indicate whether the task has been created for startMode or a finishMode set to manual.
 java.lang.String getStartedBy()
          Returns the user starting the task.
 java.util.Date getStartedDate()
          Returns the date recorded when the task is started.
 org.ow2.bonita.util.Constants.TaskState getState()
          Returns the state of the task.
 java.lang.String getUserId()
          Returns the assigned user for the task.
 
Methods inherited from interface org.ow2.bonita.facade.runtime.RuntimeRecord
getInstanceId, getProcessId
 
Methods inherited from interface org.ow2.bonita.facade.Record
getDeploymentId, getId, getPackageId
 

Method Detail

getCandidates

java.util.Set<java.lang.String> getCandidates()
Returns the set of users that has been set to the candidates list. This list depends on the type of performer that has been defined for the activity. If the performer references an Xpdl participant with a human type this list contains this user. If the performer references an Xpdl participant with a role type this list contains the users being resolved by the role mapper (assuming a role mapper has been defined within the participant having the role type). In this case if no role mapper is defined the returned list contains the participant id.

Returns:
A set of candidates.

getUserId

java.lang.String getUserId()
Returns the assigned user for the task. If the performer references an Xpdl participant with a human type the returned userId is the user id of the participant. If the performer references an Xpdl participant with a role type the returned userId depends on the performer assignment defined within the activity definition. In this case if no performer assignment is defined it returns null.

Returns:
The assigned user for the task.

getStartedBy

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

Returns:
The user starting the task.

getStartedDate

java.util.Date getStartedDate()
Returns the date recorded when the task is started.

Returns:
The date recorded when the task is started.

getEndedDate

java.util.Date getEndedDate()
Returns the date recorded when the task is finished.

Returns:
The date recorded when the task is finished.

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.

getSignal

java.lang.String getSignal()
The signal is used to indicate whether the task has been created for startMode or a finishMode set to manual. Note: finishMode set to manual is not supported.

Returns:
The signal indicating whether the task is for startMode or finishMode.

getActivityId

java.lang.String getActivityId()
Returns the activity id for which the task is attached. The activity id is one defined into the Activity element of the xpdl file.

Returns:
The activity id.

getState

org.ow2.bonita.util.Constants.TaskState getState()
Returns the state of the task.

Returns:
The state of the task.