Package com.lexmark.saperion.workflow

Interface WorkflowInboxService

All Superinterfaces:

com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>

All Known Implementing Classes:

AbstractWorkflowInboxDelegateService, WorkflowInboxDelegateService

public interface WorkflowInboxService
extends com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>

This service provides functionality concerning workflow inboxes.

Method Summary

Modifier and Type	Method	Description
InboxListItemType	getInbox(InboxReferenceType reference)	Returns the inbox with the specified ID.
InboxListItemType	getPersonalInbox()	Returns the personal inbox of the current user.
com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>	newInboxTypeSearchService(InboxTypeEnumeration inboxType)	This method returns a search execution service that searches all inboxes of a specific type.
com.lexmark.saperion.search.SearchExecutionService<TaskListItemType>	newTaskSearchService(InboxReferenceType reference)	This method creates an new search execution service that searches tasks that are contained in the referenced workflow inbox.
com.lexmark.saperion.search.SearchResultPage<InboxListItemType>	search(com.lexmark.saperion.search.query.Statement statement, com.lexmark.saperion.search.PageDefinition pageDefinition)	This method returns a list of information about all inboxes of the current user.

Method Detail

search

com.lexmark.saperion.search.SearchResultPage<InboxListItemType> search(com.lexmark.saperion.search.query.Statement statement,
                                                                       com.lexmark.saperion.search.PageDefinition pageDefinition)
                                                                throws com.lexmark.saperion.exceptions.EcmException

This method returns a list of information about all inboxes of the current user. It can be filtered and is paged.

Specified by:

search in interface com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>

Parameters:

statement - additional filter on the inboxes

pageDefinition - the page of the result to return

Returns:

list of inboxes

Throws:

com.lexmark.saperion.exceptions.EcmException

newInboxTypeSearchService

com.lexmark.saperion.search.SearchExecutionService<InboxListItemType> newInboxTypeSearchService(InboxTypeEnumeration inboxType)
                                                                                         throws com.lexmark.saperion.exceptions.EcmException

This method returns a search execution service that searches all inboxes of a specific type.

Parameters:

inboxType - the type to search for

Returns:

a search execution service that searches all inboxes of a specific type

Throws:

com.lexmark.saperion.exceptions.EcmException

getInbox

InboxListItemType getInbox(InboxReferenceType reference)
                    throws com.lexmark.saperion.exceptions.EcmException

Returns the inbox with the specified ID.

Parameters:

reference - the reference of the inbox in base64 encoded form of {"id":xxx}

Returns:

the inbox with the specified ID

Throws:

com.lexmark.saperion.exceptions.EcmException

getPersonalInbox

InboxListItemType getPersonalInbox()
                            throws com.lexmark.saperion.exceptions.EcmException

Returns the personal inbox of the current user.

Returns:

the personal inbox

Throws:

com.lexmark.saperion.exceptions.EcmException

newTaskSearchService

com.lexmark.saperion.search.SearchExecutionService<TaskListItemType> newTaskSearchService(InboxReferenceType reference)
                                                                                   throws com.lexmark.saperion.exceptions.EcmException

This method creates an new search execution service that searches tasks that are contained in the referenced workflow inbox.

Parameters:

reference - a reference to the inbox to get the tasks for in base64 encoded form of {"id":xxx}

Returns:

a list of tasks

Throws:

com.lexmark.saperion.exceptions.system.SystemException - datasource not available workflow definition not available system error when retrieving tasks configuration error

com.lexmark.saperion.exceptions.application.SearchException - database error when retrieving tasks

com.lexmark.saperion.exceptions.EcmException