com.oracle.services.bpel.task
Interface ITask

public interface ITask

This interface allows the user to interact with a task that has been instantiated in a process domain.

Tasks are special instances of activities where the performer of the activity is manual rather than automated. Tasks may be assigned to particular assignees and may have expiration times associated with them.

Since:

2.0

Field Summary

static java.lang.String	NAMESPACE_URI
static java.lang.String	STATUS_ACTIVE
static java.lang.String	STATUS_CANCELLED
static java.lang.String	STATUS_COMPLETED

Method Summary

java.lang.String	getAssignee() Returns the current assignee for this task.
java.lang.Object	getAttachment() Returns the contents (attachment) of the task.
java.lang.String	getConclusion()
java.util.Calendar	getCreationDate()
java.lang.String	getCreator() Returns the creator identifier for this task.
java.lang.String	getCustomKey() Returns the lookup key for this task.
Duration	getDuration() Returns the expiration duration specified for this task.
java.util.Calendar	getExpirationDate() Returns the expiration date for this task.
java.lang.String	getModifier() Returns the performer for this task.
java.util.Calendar	getModifyDate()
int	getPriority() Returns the current priority of this task.
java.lang.String	getStatus() Returns the state for this task.
java.lang.String	getTaskId() Returns the unique identifier for this task.
java.lang.String	getTemplate() Returns the name of the template for this task.
java.lang.String	getTitle() Returns the current title for this task.
boolean	isExpired() Returns true if the task is expired otherwise it returns false.
void	setAssignee(java.lang.String assignee) Sets the current assignee for this task.
void	setAttachment(java.lang.Object payload) Sets the contents (attachment) of the task.
void	setConclusion(java.lang.String conclusion)
void	setCreationDate(java.util.Calendar creationDate) Sets the creation date for this task.
void	setCreator(java.lang.String creator) Sets the creator identifier for this task.
void	setCustomKey(java.lang.String customKey) Sets the lookup key for this task.
void	setDuration(Duration duration) Sets the expiration duration specified for this task.
void	setExpirationDate(java.util.Calendar expirationDate) Sets the expiration date for this task.
void	setExpired(boolean expired) Sets the task to be expired.
void	setModifier(java.lang.String modifier)
void	setModifyDate(java.util.Calendar modifyDate)
void	setPriority(int priority) Sets the current priority of this task.
void	setTaskId(java.lang.String taskId) Sets the unique identifier for this task.
void	setTemplate(java.lang.String template) Sets the name of the template for this task.
void	setTitle(java.lang.String title) Sets the current title for this task.

Field Detail

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI

See Also:

Constant Field Values

STATUS_ACTIVE

public static final java.lang.String STATUS_ACTIVE

See Also:

Constant Field Values

STATUS_COMPLETED

public static final java.lang.String STATUS_COMPLETED

See Also:

Constant Field Values

STATUS_CANCELLED

public static final java.lang.String STATUS_CANCELLED

See Also:

Constant Field Values

Method Detail

getTaskId

public java.lang.String getTaskId()

Returns the unique identifier for this task. This value is generated automatically by the system and is used to lookup the task internally.

setTaskId

public void setTaskId(java.lang.String taskId)

Sets the unique identifier for this task. This value is generated automatically by the system and is used to lookup the task internally; it should not be modified.

getTitle

public java.lang.String getTitle()

Returns the current title for this task.

The semantics attached to the title value are the sole domain and responsibility of the developer.

setTitle

public void setTitle(java.lang.String title)

Sets the current title for this task.

The semantics attached to the title value are the sole domain and responsibility of the developer.

getCreationDate

public java.util.Calendar getCreationDate()

setCreationDate

public void setCreationDate(java.util.Calendar creationDate)

Sets the creation date for this task.

getCreator

public java.lang.String getCreator()

Returns the creator identifier for this task.

The semantics attached to the value of the creator are the sole domain and responsibility of the developer.

setCreator

public void setCreator(java.lang.String creator)

Sets the creator identifier for this task.

The semantics attached to the value of the creator are the sole domain and responsibility of the developer.

getModifyDate

public java.util.Calendar getModifyDate()

setModifyDate

public void setModifyDate(java.util.Calendar modifyDate)

getModifier

public java.lang.String getModifier()

Returns the performer for this task. The task may be assigned to a particular user but may be completed or performed by another user. This field can be used to store the identifier of the user who actually completed the task.

setModifier

public void setModifier(java.lang.String modifier)

getAssignee

public java.lang.String getAssignee()

Returns the current assignee for this task.

The semantics attached to the value of the assignee are the sole domain and responsibility of the developer.

setAssignee

public void setAssignee(java.lang.String assignee)

Sets the current assignee for this task.

The semantics attached to the value of the assignee are the sole domain and responsibility of the developer.

getStatus

public java.lang.String getStatus()

Returns the state for this task. This value is used by the system to indicate the state this task. Currently supported values are:

• active
  

  - task is active and has not been completed,

• completed
  

  - task has been completed,

getExpirationDate

public java.util.Calendar getExpirationDate()

Returns the expiration date for this task. There are two ways to set an expiration time for the task:

• specify an absolute datetime,
• specify a duration relative to the task's creation time.

setExpirationDate

public void setExpirationDate(java.util.Calendar expirationDate)

Sets the expiration date for this task. There are two ways to set an expiration time for the task:

• specify an absolute datetime,
• specify a duration relative to the task's creation time.

getDuration

public Duration getDuration()

Returns the expiration duration specified for this task. There are two ways to set an expiration time for the task:

• specify an absolute datetime,
• specify a duration relative to the task's creation time.

setDuration

public void setDuration(Duration duration)

Sets the expiration duration specified for this task. There are two ways to set an expiration time for the task:

• specify an absolute datetime,
• specify a duration relative to the task's creation time.

getPriority

public int getPriority()

Returns the current priority of this task.

The semantics attached to the priority value are the sole domain and responsibility of the developer.

setPriority

public void setPriority(int priority)

Sets the current priority of this task.

The semantics attached to the priority value are the sole domain and responsibility of the developer.

getTemplate

public java.lang.String getTemplate()

Returns the name of the template for this task. A task template is a set of initialization properties and a custom executable tasklet that is executed whenever a task's state is updated:

• on task initialization,
• on task update,
• on task completion,
• on task expiration

Task templates are deployed to each process domain.

setTemplate

public void setTemplate(java.lang.String template)

Sets the name of the template for this task. A task template is a set of initialization properties and a custom executable tasklet that is executed whenever a task's state is updated:

• on task initialization,
• on task update,
• on task completion,
• on task expiration

Task templates are deployed to each process domain.

getCustomKey

public java.lang.String getCustomKey()

Returns the lookup key for this task. The value specified for this key can be used to uniquely lookup this task; this key has no system-specific meaning.

The semantics attached to the value of the key are the sole domain and responsibility of the developer.

setCustomKey

public void setCustomKey(java.lang.String customKey)

Sets the lookup key for this task. The value specified for this key can be used to uniquely lookup this task; this key has no system-specific meaning.

The semantics attached to the value of the key are the sole domain and responsibility of the developer.

getConclusion

public java.lang.String getConclusion()

setConclusion

public void setConclusion(java.lang.String conclusion)

getAttachment

public java.lang.Object getAttachment()
                               throws ServerException

Returns the contents (attachment) of the task. This value can be of any type.

Throws:

ServerException - if there is a problem in loading the task from the process domain.

setAttachment

public void setAttachment(java.lang.Object payload)

Sets the contents (attachment) of the task. This value can be of any type.

isExpired

public boolean isExpired()

Returns true if the task is expired otherwise it returns false.

setExpired

public void setExpired(boolean expired)

Sets the task to be expired.

Parameters:

expired - - true if the task needs to be expired otherwise false.