Package com.webmethods.portal.service.task

Interface ITaskDistributionService

All Superinterfaces:

IComponent, IInitializable, ITaskComponent

public interface ITaskDistributionService
extends ITaskComponent

Class ITaskDistributionService

Method Summary

Modifier and Type	Method	Description
void	addTaskToInbox(IURI inboxSourceURI, IURI taskURI, IURI referenceURI, int type)	Adds a task to the source inbox.
List<IThingID>	getPrincipalActors(IURI[] principalURIs, boolean includeRoles)
ITaskListIterator	listAllTasks()	Queries all the tasks in the system.
List<ITaskInboxEntry>	listTaskInboxes(IURI inboxURI, IURI taskURI, IURI referenceURI, int type)	Lists all inboxes where task belongs
ITaskInboxListIterator	listUserTasks(IURI principalURI, boolean includeRoles)	Queries for tasks assigned to particular user
void	removeTaskFromAll(IURI taskURI, int type)	Removes task from all inboxes.
void	removeTaskFromInbox(IURI inboxSourceURI, IURI taskURI, IURI referenceURI, int type)	Removes given task from the given inbox
ITaskListIterator	searchAllTasks(TaskSearchQuery query)	Searches all tasks
ITaskListIterator	searchAllTasks(TaskSearchQuery query, Boolean isASC)	Searches all tasks
List<ITaskSearchRecord>	searchAllTasksByTagPaged(TaskSearchQueryV2 query, boolean includeBusData)	Searches all tasks in the system and returns one page result as specified by query and tags
int	searchAllTasksByTagTotalCount(TaskSearchQueryV2 query, boolean includeBusData)	Searches all tasks and returns how total number of tasks found
List<ITaskSearchRecord>	searchAllTasksPaged(TaskSearchQueryV2 query, boolean includeBusData)	Searches all tasks in the system and returns one page result as specified by query
int	searchAllTasksTotalCount(TaskSearchQueryV2 query, boolean includeBusData)	Searches all tasks and returns how total number of tasks found
ITaskInboxListIterator	searchUserTasks(IURI[] principalURI, TaskSearchQuery query, boolean includeRoles, String inboxType)	Searches multiple user inbox tasks
ITaskInboxListIterator	searchUserTasks(IURI principalURI, TaskSearchQuery query, boolean includeRoles, String inboxType)	Searches user inbox tasks
List<ITaskSearchRecord>	searchUserTasksByTagPaged(IURI[] principalURIs, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData)	Searches user inbox task and returns one page result as specified by query
int	searchUserTasksByTagTotalCount(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData)	Searches user inbox tasks and returns how total number of tasks found
List<ITaskSearchRecord>	searchUserTasksPaged(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType)	Searches user inbox task and returns one page result as specified by query
List<ITaskSearchRecord>	searchUserTasksPaged(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType, boolean excludeVoted)	Searches user inbox task and returns one page result as specified by query
int	searchUserTasksTotalCount(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType)	Searches user inbox tasks and returns how total number of tasks found
int	searchUserTasksTotalCount(IURI[] principalURIs, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType, boolean excludeVoted)	Searches user inbox tasks and returns the total number of tasks.

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

Method Details

addTaskToInbox

void addTaskToInbox(IURI inboxSourceURI,
 IURI taskURI,
 IURI referenceURI,
 int type)
             throws PortalException

Adds a task to the source inbox.

Parameters:

inboxSourceURI - uri of the inbox source. This could be principalURI, or workflow actor URI or any other URIs

taskURI - task uri to be added to inbox

type - type of the inbox entry

Throws:

PortalException

removeTaskFromInbox

void removeTaskFromInbox(IURI inboxSourceURI,
 IURI taskURI,
 IURI referenceURI,
 int type)
                  throws PortalException

Removes given task from the given inbox

Parameters:

inboxSourceURI - source inbox uri

taskURI - task to be removed

type - only specified type entries will be removed

Throws:

PortalException

removeTaskFromAll

void removeTaskFromAll(IURI taskURI,
 int type)
                throws PortalException

Removes task from all inboxes.

Parameters:

taskURI - task to be removed

type - only specified type entries will be removed

Throws:

PortalException

listTaskInboxes

List<ITaskInboxEntry> listTaskInboxes(IURI inboxURI,
 IURI taskURI,
 IURI referenceURI,
 int type)
                               throws PortalException

Lists all inboxes where task belongs

Parameters:

taskURI - task uri

Returns:

List of ITaskInboxEntry objects

Throws:

PortalException

listAllTasks

ITaskListIterator listAllTasks()
                        throws PortalException

Queries all the tasks in the system.

Throws:

PortalException

searchAllTasks

ITaskListIterator searchAllTasks(TaskSearchQuery query)
                          throws PortalException

Searches all tasks

Throws:

PortalException

searchAllTasks

ITaskListIterator searchAllTasks(TaskSearchQuery query,
 Boolean isASC)
                          throws PortalException

Searches all tasks

Throws:

PortalException

searchUserTasks

ITaskInboxListIterator searchUserTasks(IURI principalURI,
 TaskSearchQuery query,
 boolean includeRoles,
 String inboxType)
                                throws PortalException

Searches user inbox tasks

Throws:

PortalException

searchUserTasks

ITaskInboxListIterator searchUserTasks(IURI[] principalURI,
 TaskSearchQuery query,
 boolean includeRoles,
 String inboxType)
                                throws PortalException

Searches multiple user inbox tasks

Throws:

PortalException

searchUserTasksPaged

List<ITaskSearchRecord> searchUserTasksPaged(IURI[] principalURI,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData,
 String inboxType)
                                      throws PortalException

Searches user inbox task and returns one page result as specified by query

Throws:

PortalException

searchUserTasksPaged

List<ITaskSearchRecord> searchUserTasksPaged(IURI[] principalURI,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData,
 String inboxType,
 boolean excludeVoted)
                                      throws PortalException

Searches user inbox task and returns one page result as specified by query

Parameters:

excludeVoted - to exclude tasks which have been already voted on by the user

Throws:

PortalException

searchAllTasksPaged

List<ITaskSearchRecord> searchAllTasksPaged(TaskSearchQueryV2 query,
 boolean includeBusData)
                                     throws PortalException

Searches all tasks in the system and returns one page result as specified by query

Throws:

PortalException

searchAllTasksByTagPaged

List<ITaskSearchRecord> searchAllTasksByTagPaged(TaskSearchQueryV2 query,
 boolean includeBusData)
                                          throws PortalException

Searches all tasks in the system and returns one page result as specified by query and tags

Throws:

PortalException

searchUserTasksByTagPaged

List<ITaskSearchRecord> searchUserTasksByTagPaged(IURI[] principalURIs,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData)
                                           throws PortalException

Searches user inbox task and returns one page result as specified by query

Throws:

PortalException

searchUserTasksTotalCount

int searchUserTasksTotalCount(IURI[] principalURI,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData,
 String inboxType)
                       throws PortalException

Searches user inbox tasks and returns how total number of tasks found

Throws:

PortalException

searchUserTasksTotalCount

int searchUserTasksTotalCount(IURI[] principalURIs,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData,
 String inboxType,
 boolean excludeVoted)
                       throws PortalException

Searches user inbox tasks and returns the total number of tasks.

Parameters:

excludeVoted - to exclude tasks which have been already voted on by the user.

Throws:

PortalException

searchAllTasksTotalCount

int searchAllTasksTotalCount(TaskSearchQueryV2 query,
 boolean includeBusData)
                      throws PortalException

Searches all tasks and returns how total number of tasks found

Throws:

PortalException

searchUserTasksByTagTotalCount

int searchUserTasksByTagTotalCount(IURI[] principalURI,
 TaskSearchQueryV2 query,
 boolean includeRoles,
 boolean includeBusData)
                            throws PortalException

Searches user inbox tasks and returns how total number of tasks found

Throws:

PortalException

searchAllTasksByTagTotalCount

int searchAllTasksByTagTotalCount(TaskSearchQueryV2 query,
 boolean includeBusData)
                           throws PortalException

Searches all tasks and returns how total number of tasks found

Throws:

PortalException

listUserTasks

ITaskInboxListIterator listUserTasks(IURI principalURI,
 boolean includeRoles)
                              throws PortalException

Queries for tasks assigned to particular user

Throws:

PortalException

getPrincipalActors

List<IThingID> getPrincipalActors(IURI[] principalURIs,
 boolean includeRoles)
                           throws PortalException

Throws:

PortalException