com.saperion.workflow

Interface WorkflowInboxService

All Known Implementing Classes:

RmiClientWorkflowInboxService

public interface WorkflowInboxService

This component is injectable to operations and provides functionality concerning workflow inboxes.

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.workflow.InboxListItemType	getInbox(com.lexmark.saperion.workflow.InboxReferenceType reference) Returns the inbox with the specified ID.
com.lexmark.saperion.workflow.InboxListItemType	getPersonalInbox() Returns the personal inbox of the current user.
List<com.lexmark.saperion.workflow.TaskListItemType>	getTaskList(com.lexmark.saperion.workflow.InboxReferenceType reference) Returns a list of tasks that are contained in the referenced workflow inbox.
List<com.lexmark.saperion.workflow.InboxListItemType>	listInboxes() Returns a list of information about all inboxes of the current user.

Method Detail

listInboxes

List<com.lexmark.saperion.workflow.InboxListItemType> listInboxes()
                                                                  throws SaAuthenticationException,
                                                                         SaSystemException,
                                                                         SaDBException

Returns a list of information about all inboxes of the current user.

Returns:

list of inboxes

Throws:

SaAuthenticationException - authentication-error when retrieving inboxes

SaSystemException - system-error when retrieving inboxes

SaDBException - database-error when retrieving inboxes

getInbox

com.lexmark.saperion.workflow.InboxListItemType getInbox(com.lexmark.saperion.workflow.InboxReferenceType reference)
                                                         throws SaAuthenticationException,
                                                                SaSystemException,
                                                                SaDBException

Returns the inbox with the specified ID.

Parameters:

reference - the reference (ID) of the inbox

Returns:

the inbox with the specified ID

Throws:

SaAuthenticationException - authentication-error when retrieving inboxes

SaSystemException - system-error when retrieving inboxes

SaDBException - database-error when retrieving inboxes

getPersonalInbox

com.lexmark.saperion.workflow.InboxListItemType getPersonalInbox()
                                                                 throws SaAuthenticationException,
                                                                        SaSystemException,
                                                                        SaDBException

Returns the personal inbox of the current user.

Returns:

the personal inbox

Throws:

SaAuthenticationException - authentication-error when retrieving inboxes

SaSystemException - system-error when retrieving inboxes

SaDBException - database-error when retrieving inboxes

getTaskList

List<com.lexmark.saperion.workflow.TaskListItemType> getTaskList(com.lexmark.saperion.workflow.InboxReferenceType reference)
                                                                 throws SaAuthenticationException,
                                                                        DataSourceException,
                                                                        UnknownDefinitionException,
                                                                        SaSystemException,
                                                                        SaperionConfigurationException,
                                                                        SaDBException

Returns a list of tasks that are contained in the referenced workflow inbox.

Parameters:

reference - a reference to the inbox to get the tasks for

Returns:

a list of tasks

Throws:

SaAuthenticationException - authentication error when retrieving tasks

DataSourceException - datasource not available

UnknownDefinitionException - workflwo definition not available

SaSystemException - system error when retrieving tasks

SaperionConfigurationException - configuration error

SaDBException - database error when retrieving tasks