org.jbpm.api.task
Interface Task

All Superinterfaces:

java.io.Serializable

public interface Task
extends java.io.Serializable

a runtime task. In contrast to HistoryTask, a Task only represents the runtime state of a task and hence it will be deleted after it is completed.

Author:

Tom Baeyens

Field Summary

static java.lang.String	STATE_COMPLETED task is done
static java.lang.String	STATE_OPEN task is waiting for someone to work on it and completed it
static java.lang.String	STATE_SUSPENDED task doesn't show up in task lists as something is wrong with the related process instance that requires manual intervention first.

Method Summary

java.lang.String	getActivityName() reference to the activity or null if this task is unrelated to an activity
java.lang.String	getAssignee() the person responsible for completion of this task.
java.util.Date	getCreateTime() date and time when this task was created
java.lang.String	getDescription() longer description of this task
java.util.Date	getDuedate() date and time when this task must be completed.
java.lang.String	getExecutionId() reference to the execution or null if this task is unrelated to an execution
java.lang.String	getFormResourceName() name of the resource in the deployment for the form that is associated to this task.
java.lang.String	getId() the unique id for this task that is used as a reference in the service methods
java.lang.String	getName() the short display name of this task.
int	getPriority() the priority of this task.
java.lang.Integer	getProgress() The progress of this task.
void	setAssignee(java.lang.String assignee) update the assignee of this task.
void	setDescription(java.lang.String description) update the longer description of this task.
void	setDuedate(java.util.Date duedate) update the date and time when this task must be completed.
void	setName(java.lang.String name) change the short display name of this tasks.
void	setPriority(int priority) update the priority.
void	setProgress(java.lang.Integer progress) Change the progress of this task.

Field Detail

STATE_OPEN

static final java.lang.String STATE_OPEN

task is waiting for someone to work on it and completed it

See Also:

Constant Field Values

STATE_COMPLETED

static final java.lang.String STATE_COMPLETED

task is done

See Also:

Constant Field Values

STATE_SUSPENDED

static final java.lang.String STATE_SUSPENDED

task doesn't show up in task lists as something is wrong with the related process instance that requires manual intervention first.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

the unique id for this task that is used as a reference in the service methods

getName

java.lang.String getName()

the short display name of this task. Originally, this might come from the process file, but it can be changed at runtime for individual tasks.

setName

void setName(java.lang.String name)

change the short display name of this tasks. Updates require you to invoke TaskService.saveTask(Task) afterwards.

getDescription

java.lang.String getDescription()

longer description of this task

setDescription

void setDescription(java.lang.String description)

update the longer description of this task. Updates like this require you to invoke TaskService.saveTask(Task) afterwards.

getAssignee

java.lang.String getAssignee()

the person responsible for completion of this task.

setAssignee

void setAssignee(java.lang.String assignee)

update the assignee of this task. Updates like this require you to invoke TaskService.saveTask(Task) afterwards.

getCreateTime

java.util.Date getCreateTime()

date and time when this task was created

getDuedate

java.util.Date getDuedate()

date and time when this task must be completed. This might be null.

setDuedate

void setDuedate(java.util.Date duedate)

update the date and time when this task must be completed. Updates like this require you to invoke TaskService.saveTask(Task) afterwards.

getPriority

int getPriority()

the priority of this task. This is only a data item for user purposes. The engine doesn't do anything different for different priorities.

setPriority

void setPriority(int priority)

update the priority. Updates like this require you to invoke TaskService.saveTask(Task) afterwards.

getProgress

java.lang.Integer getProgress()

The progress of this task. This is a data item for user purposes and doesn't influence the functionality of the engine.

setProgress

void setProgress(java.lang.Integer progress)

Change the progress of this task. Updates like this require you to invoke TaskService.saveTask(Task) afterwards. IMPORTANT: Only values between 0 and 100 are accepted. Using other values will cause a JbpmException.

getExecutionId

java.lang.String getExecutionId()

reference to the execution or null if this task is unrelated to an execution

getActivityName

java.lang.String getActivityName()

reference to the activity or null if this task is unrelated to an activity

getFormResourceName

java.lang.String getFormResourceName()

name of the resource in the deployment for the form that is associated to this task.