com.saperion.connector.workflow

Class RmiClientWorkflowInboxService

java.lang.Object

com.saperion.connector.workflow.RmiClientWorkflowInboxService

All Implemented Interfaces:

WorkflowInboxService

public class RmiClientWorkflowInboxService
extends Object
implements WorkflowInboxService

This WorkflowInboxService provides access to workflow inboxes on the client-side.

Constructor Summary

Constructors

Constructor and Description
RmiClientWorkflowInboxService(Connection connection)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RmiClientWorkflowInboxService

public RmiClientWorkflowInboxService(Connection connection)

Method Detail

listInboxes

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

Description copied from interface: WorkflowInboxService

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

Specified by:

listInboxes in interface WorkflowInboxService

Returns:

list of inboxes

Throws:

SaAuthenticationException - authentication-error when retrieving inboxes

SaSystemException - system-error when retrieving inboxes

SaDBException - database-error when retrieving inboxes

getInbox

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

Description copied from interface: WorkflowInboxService

Returns the inbox with the specified ID.

Specified by:

getInbox in interface WorkflowInboxService

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

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

Description copied from interface: WorkflowInboxService

Returns the personal inbox of the current user.

Specified by:

getPersonalInbox in interface WorkflowInboxService

Returns:

the personal inbox

Throws:

SaAuthenticationException - authentication-error when retrieving inboxes

SaSystemException - system-error when retrieving inboxes

SaDBException - database-error when retrieving inboxes

getTaskList

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

Description copied from interface: WorkflowInboxService

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

Specified by:

getTaskList in interface WorkflowInboxService

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