com.webmethods.portal.bizPolicy.biz.task

Interface ITaskBizPolicy

All Superinterfaces:

IBasicPolicy, IBizPolicy, IComponent, IInitializable, ISystemHandler, IViewablePolicy

public interface ITaskBizPolicy
extends IBasicPolicy

Class ITaskBizPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static int	UPDATE_RESULT_SUCCESS
static int	UPDATE_RESULT_TASK_MUTABLE
static int	UPDATE_RESULT_TASK_NOT_UP_TO_DATE

Method Summary

Modifier and Type	Method and Description
IURI	createTask(IContext context, IURI taskDefinitionURI, Map<String,?> properties) Creates new task
void	formFlowTaskNotify(IContext context, String correlationID, String result, boolean localOnly) When using the TaskFormFlowService to coordinate task flow, send a notification that the next task in the flow is available
RecalculationStatus	getRecalculationStatus(IContext context, String taskTypeID)
ITask	getTask(IContext context, IURI taskURI) Returns task view by its uri
Object	getTaskData(IContext context, IURI taskURI) Returns custom task data by task uri
IURI	getTaskDelegatedBy(IContext context, IURI taskURI, IURI principalURI) Returns uri of the principal who delegated the given task to the given principal
boolean	isTaskAssignedToUser(IContext context, IURI taskURI, IURI principalURI) Checks if task is still assigned to the user
ITaskList	listAllTasks(IContext context) Searches list of all tasks
ITaskList	listUserTasks(IContext context, IURI principalURI) Returns list of tasks assigned to the specified user
void	rollbackTask(IContext context, IURI taskURI, int auditEntryID) Reverts task state to identified by audit entry ID
ITaskList	searchAllTasks(IContext context, TaskSearchQuery taskQuery) Searches list of all tasks
List<ITaskSearchRecord>	searchAllTasksPaged(IContext context, TaskSearchQueryV2 taskQuery, boolean businessData)
int	searchAllTasksTotalCount(IContext context, TaskSearchQueryV2 taskQuery, boolean businessData)
ITaskList	searchUserTasks(IContext context, IURI principalURI, TaskSearchQuery taskQuery) Returns list of tasks assigned to the specified user
List<ITaskSearchRecord>	searchUserTasksPaged(IContext context, IURI principalURI, TaskSearchQueryV2 taskQuery, boolean businessData)
int	searchUserTasksTotalCount(IContext context, IURI principalURI, TaskSearchQueryV2 taskQuery, boolean businessData)
String[]	setInstancesStatus(IContext context, String taskTypeID, String status, boolean logInFile, int batchSize)
void	startVoteRecalculation(IContext context, String taskTypeID) Recalculate status of voting for given task type
void	stopVoteRecalculation(IContext context, String taskTypeID) Stop recalculation of vote status
int	updateTask(IContext context, IURI taskURI, Map<String,?> properties) Updates task custom data
int	updateTask(IContext context, IURI taskURI, Map<String,?> properties, int taskVersionNumber, boolean lockTask, boolean hiddenUpdate) Updates the task
void	voteTask(IContext context, String taskID, String status, String user) Vote with a specific status for a certain task.

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.meta.IBasicPolicy

addNote, addToTopics, canUser, cloneRemote, copyToClipboard, cutToClipboard, delete, deleteReference, destroy, getContent, listContainers, listNotes, moveThing, moveThing, pasteFromClipboard, removeNote, setOwner, updateProperties

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.view.IViewablePolicy

getIcon, getPagingCookie, getPagingCookie, pageBackward, pageForeward, setPagingCookie, view

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Field Detail

UPDATE_RESULT_SUCCESS

static final int UPDATE_RESULT_SUCCESS

See Also:

Constant Field Values

UPDATE_RESULT_TASK_MUTABLE

static final int UPDATE_RESULT_TASK_MUTABLE

See Also:

Constant Field Values

UPDATE_RESULT_TASK_NOT_UP_TO_DATE

static final int UPDATE_RESULT_TASK_NOT_UP_TO_DATE

See Also:

Constant Field Values

Method Detail

createTask

IURI createTask(IContext context,
                IURI taskDefinitionURI,
                Map<String,?> properties)
         throws BizException

Creates new task

Parameters:

context - execution context

taskDefinitionURI - task type

properties - additional properties (like name, description)

Returns:

created task uri

Throws:

BizException

rollbackTask

void rollbackTask(IContext context,
                  IURI taskURI,
                  int auditEntryID)
           throws BizException

Reverts task state to identified by audit entry ID

Parameters:

context -

taskURI -

auditEntryID -

Throws:

BizException

updateTask

int updateTask(IContext context,
               IURI taskURI,
               Map<String,?> properties)
        throws BizException

Updates task custom data

Parameters:

context -

taskURI - task uri to update data for

Throws:

BizException

updateTask

int updateTask(IContext context,
               IURI taskURI,
               Map<String,?> properties,
               int taskVersionNumber,
               boolean lockTask,
               boolean hiddenUpdate)
        throws BizException

Updates the task

Parameters:

context -

taskURI -

properties -

taskVersionNumber -

lockTask -

Throws:

BizException

getTask

ITask getTask(IContext context,
              IURI taskURI)
       throws BizException

Returns task view by its uri

Parameters:

context -

taskURI - task uri to fetch

Returns:

task instance of null if not found

Throws:

BizException

getTaskData

Object getTaskData(IContext context,
                   IURI taskURI)
            throws BizException

Returns custom task data by task uri

Parameters:

context -

taskURI - task uri to fetch

Returns:

custom task data

Throws:

BizException

isTaskAssignedToUser

boolean isTaskAssignedToUser(IContext context,
                             IURI taskURI,
                             IURI principalURI)
                      throws BizException

Checks if task is still assigned to the user

Parameters:

context -

taskURI - task uri to check

principalURI - principal uri to check

Returns:

Throws:

BizException

getTaskDelegatedBy

IURI getTaskDelegatedBy(IContext context,
                        IURI taskURI,
                        IURI principalURI)
                 throws BizException

Returns uri of the principal who delegated the given task to the given principal

Parameters:

context -

taskURI - task uri to check

principalURI - principal uri whom task was delegated

Returns:

uri of the principal who delegated task or null if task was not delegated

Throws:

BizException

listAllTasks

ITaskList listAllTasks(IContext context)
                throws BizException

Searches list of all tasks

Parameters:

context - For example query: "name=order*,status=completed"

Returns:

Throws:

BizException

listUserTasks

ITaskList listUserTasks(IContext context,
                        IURI principalURI)
                 throws BizException

Returns list of tasks assigned to the specified user

Parameters:

context -

principalURI - principal uri which tasks should be returned

Returns:

Throws:

BizException

searchAllTasks

ITaskList searchAllTasks(IContext context,
                         TaskSearchQuery taskQuery)
                  throws BizException

Searches list of all tasks

Parameters:

context - For example query: "name=order*,status=completed"

Returns:

Throws:

BizException

searchUserTasks

ITaskList searchUserTasks(IContext context,
                          IURI principalURI,
                          TaskSearchQuery taskQuery)
                   throws BizException

Returns list of tasks assigned to the specified user

Parameters:

context -

principalURI - principal uri which tasks should be returned

Returns:

Throws:

BizException

searchUserTasksPaged

List<ITaskSearchRecord> searchUserTasksPaged(IContext context,
                                             IURI principalURI,
                                             TaskSearchQueryV2 taskQuery,
                                             boolean businessData)
                                      throws BizException

Throws:

BizException

searchUserTasksTotalCount

int searchUserTasksTotalCount(IContext context,
                              IURI principalURI,
                              TaskSearchQueryV2 taskQuery,
                              boolean businessData)
                       throws BizException

Throws:

BizException

searchAllTasksPaged

List<ITaskSearchRecord> searchAllTasksPaged(IContext context,
                                            TaskSearchQueryV2 taskQuery,
                                            boolean businessData)
                                     throws BizException

Throws:

BizException

searchAllTasksTotalCount

int searchAllTasksTotalCount(IContext context,
                             TaskSearchQueryV2 taskQuery,
                             boolean businessData)
                      throws BizException

Throws:

BizException

formFlowTaskNotify

void formFlowTaskNotify(IContext context,
                        String correlationID,
                        String result,
                        boolean localOnly)
                 throws BizException

When using the TaskFormFlowService to coordinate task flow, send a notification that the next task in the flow is available

Parameters:

context -

correlationID - the correction ID used by TaskFormFlowService to uniquely identify a form flow

result - the result of the task flow, usually the task URL of the next task in the flow

localOnly - wait for in-proc notification only

Throws:

BizException

setInstancesStatus

String[] setInstancesStatus(IContext context,
                            String taskTypeID,
                            String status,
                            boolean logInFile,
                            int batchSize)
                     throws BizException

Parameters:

context - (required) execution context

taskTypeId - (required) taskTypeId which instances to be updated

status(required) - new status

logInFile - (optional) whether result should be logged in file or returned as response

batchSize - (optional) the total number of tasks instances that will be processed together

Returns:

Array of all processed task instance IDs

Throws:

BizException

voteTask

void voteTask(IContext context,
              String taskID,
              String status,
              String user)
       throws BizException

Vote with a specific status for a certain task.

Parameters:

context -

taskID -

status -

user -

Throws:

BizException

startVoteRecalculation

void startVoteRecalculation(IContext context,
                            String taskTypeID)
                     throws BizException

Recalculate status of voting for given task type

Parameters:

context -

taskTypeID -

Throws:

BizException

stopVoteRecalculation

void stopVoteRecalculation(IContext context,
                           String taskTypeID)
                    throws BizException

Stop recalculation of vote status

Parameters:

context -

taskTypeID -

Throws:

BizException

getRecalculationStatus

RecalculationStatus getRecalculationStatus(IContext context,
                                           String taskTypeID)
                                    throws BizException

Parameters:

context - (required) execution context

taskTypeID - (required) taskTypeId which Recalculation will be returned

Returns:

Recalculation status

Throws:

BizException