public interface ITaskDistributionService extends ITaskComponent
Modifier and Type | Method and 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
|
int |
searchUserTasksTotalCount(IURI[] principalURI,
TaskSearchQueryV2 query,
boolean includeRoles,
boolean includeBusData,
String inboxType)
Searches user inbox tasks and returns how total number of tasks found
|
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
void addTaskToInbox(IURI inboxSourceURI, IURI taskURI, IURI referenceURI, int type) throws PortalException
inboxSourceURI
- uri of the inbox source. This could be principalURI, or workflow actor URI or any other URIstaskURI
- task uri to be added to inboxtype
- type of the inbox entryPortalException
void removeTaskFromInbox(IURI inboxSourceURI, IURI taskURI, IURI referenceURI, int type) throws PortalException
inboxSourceURI
- source inbox uritaskURI
- task to be removedtype
- only specified type entries will be removedPortalException
void removeTaskFromAll(IURI taskURI, int type) throws PortalException
taskURI
- task to be removedtype
- only specified type entries will be removedPortalException
List<ITaskInboxEntry> listTaskInboxes(IURI inboxURI, IURI taskURI, IURI referenceURI, int type) throws PortalException
taskURI
- task uriITaskInboxEntry
objectsPortalException
ITaskListIterator listAllTasks() throws PortalException
PortalException
ITaskListIterator searchAllTasks(TaskSearchQuery query) throws PortalException
PortalException
ITaskListIterator searchAllTasks(TaskSearchQuery query, Boolean isASC) throws PortalException
PortalException
ITaskInboxListIterator searchUserTasks(IURI principalURI, TaskSearchQuery query, boolean includeRoles, String inboxType) throws PortalException
PortalException
ITaskInboxListIterator searchUserTasks(IURI[] principalURI, TaskSearchQuery query, boolean includeRoles, String inboxType) throws PortalException
PortalException
List<ITaskSearchRecord> searchUserTasksPaged(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType) throws PortalException
PortalException
List<ITaskSearchRecord> searchAllTasksPaged(TaskSearchQueryV2 query, boolean includeBusData) throws PortalException
PortalException
List<ITaskSearchRecord> searchAllTasksByTagPaged(TaskSearchQueryV2 query, boolean includeBusData) throws PortalException
PortalException
List<ITaskSearchRecord> searchUserTasksByTagPaged(IURI[] principalURIs, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData) throws PortalException
PortalException
int searchUserTasksTotalCount(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData, String inboxType) throws PortalException
PortalException
int searchAllTasksTotalCount(TaskSearchQueryV2 query, boolean includeBusData) throws PortalException
PortalException
int searchUserTasksByTagTotalCount(IURI[] principalURI, TaskSearchQueryV2 query, boolean includeRoles, boolean includeBusData) throws PortalException
PortalException
int searchAllTasksByTagTotalCount(TaskSearchQueryV2 query, boolean includeBusData) throws PortalException
PortalException
ITaskInboxListIterator listUserTasks(IURI principalURI, boolean includeRoles) throws PortalException
PortalException
List<IThingID> getPrincipalActors(IURI[] principalURIs, boolean includeRoles) throws PortalException
PortalException