Skip navigation links

com.oracle.services.bpel.task
Interface IWorklistService

All Superinterfaces:

IService

public interface IWorklistService

extends IService

The IWorklistService interface allows the user to search for and complete tasks that have been instantiated from the 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.

This service can only be fetched through the domain locator method lookupService.

Since:

2.0

Field Summary

static javax.xml.namespace.QName	QNAME Qualified XML name for the worklist service.
static java.lang.String	SERVICE_NAME Name of the worklist service.

Method Summary

void	completeTask(ITask task)
ITask[]	listTasks(int listStart, int listSize)
ITask[]	listTasks(WhereCondition cond) Returns a list of tasks using the search condition specified by cond.
ITask[]	listTasks(WhereCondition cond, int listStart, int listSize)
ITask[]	listTasksByAssignee(java.lang.String assignee) Returns a list of tasks currently assigned to assignee.
ITask[]	listTasksByCreator(java.lang.String creator) Returns a list of tasks created by creator.
ITask	lookupTask(java.lang.String taskId) Returns the task whose task identifier is specified by taskId.
void	updateTask(ITask task) Synchronizes the task properties and payload contained within the domain with the specified value.

Methods inherited from interface com.oracle.bpel.client.IService

getName

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Name of the worklist service. This name is used to lookup the service from a domain locator.

See Also:

Locator.lookupService(java.lang.String), Constant Field Values

QNAME

static final javax.xml.namespace.QName QNAME

Qualified XML name for the worklist service.

Method Detail

listTasksByAssignee

ITask[] listTasksByAssignee(java.lang.String assignee)
                            throws ServerException

Returns a list of tasks currently assigned to assignee.

Parameters:

assignee - the id of the user, group or role the listed tasks are currently assigned to.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the list of tasks from the domain.

listTasksByCreator

ITask[] listTasksByCreator(java.lang.String creator)
                           throws ServerException

Returns a list of tasks created by creator.

Parameters:

creator - the id of the application or service which which initiated the listed tasks.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the list of tasks from the domain.

listTasks

ITask[] listTasks(int listStart,
                  int listSize)
                  throws ServerException

Throws:

ServerException

listTasks

ITask[] listTasks(WhereCondition cond)
                  throws ServerException

Returns a list of tasks using the search condition specified by cond.

Parameters:

wc - the where condition filter to apply to the search.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the list of tasks from the domain.

listTasks

ITask[] listTasks(WhereCondition cond,
                  int listStart,
                  int listSize)
                  throws ServerException

Throws:

ServerException

lookupTask

ITask lookupTask(java.lang.String taskId)
                 throws ServerException

Returns the task whose task identifier is specified by taskId. A task identifier is synonymous with an instance conversation identifier; the conversation identifier of the instance that has been created for the task is the task identifier.

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

Parameters:

taskId - the task identifier

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the task from the domain.

updateTask

void updateTask(ITask task)
                throws ServerException

Synchronizes the task properties and payload contained within the domain with the specified value. This method does not complete the task.

Parameters:

task - the task to synchronize with

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem updating the task values.

completeTask

void completeTask(ITask task)
                  throws ServerException

Throws:

ServerException

Skip navigation links