Package com.lexmark.saperion.client.workflow

Interface WorkflowInboxServiceClient

All Known Implementing Classes:

WorkflowInboxServiceClientImpl

public interface WorkflowInboxServiceClient

This client serves as an entry point for searches in and for workflow in boxes.

Author:

jschwarz

Method Summary

Modifier and Type	Method	Description
SearchClient<InboxListItemType>	getGroupInboxes()	This method returns a search client for the workflow group inboxes.
SearchClient<InboxListItemType>	getInboxes()	This method returns a search client for the workflow inboxes.
SearchClient<InboxListItemType>	getOrganizationInboxes()	This method returns a search client for the workflow organization inboxes.
WorkflowInboxClient	getPersonalInbox()	This method returns a client for the personal workflow inbox.
SearchClient<InboxListItemType>	getSubstituteInboxes()	This method returns a search client for the workflow substitute inboxes.
WorkflowInboxClient	resolve(InboxReferenceType inboxId)	This method gets a client for a workflow inbox given its reference.

Method Detail

getInboxes

SearchClient<InboxListItemType> getInboxes()
                                    throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for the workflow inboxes.

Returns:

a search client for the workflow inboxes

Throws:

com.lexmark.saperion.exceptions.EcmException

getGroupInboxes

SearchClient<InboxListItemType> getGroupInboxes()
                                         throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for the workflow group inboxes.

Returns:

a search client for the workflow group inboxes

Throws:

com.lexmark.saperion.exceptions.EcmException

getSubstituteInboxes

SearchClient<InboxListItemType> getSubstituteInboxes()
                                              throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for the workflow substitute inboxes.

Returns:

a search client for the workflow substitute inboxes

Throws:

com.lexmark.saperion.exceptions.EcmException

getOrganizationInboxes

SearchClient<InboxListItemType> getOrganizationInboxes()
                                                throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for the workflow organization inboxes.

Returns:

a search client for the workflow organization inboxes

Throws:

com.lexmark.saperion.exceptions.EcmException

getPersonalInbox

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

This method returns a client for the personal workflow inbox.

Returns:

the a client for personal workflow inbox

Throws:

com.lexmark.saperion.exceptions.EcmException

resolve

WorkflowInboxClient resolve(InboxReferenceType inboxId)
                     throws com.lexmark.saperion.exceptions.EcmException

This method gets a client for a workflow inbox given its reference.

Parameters:

inboxId - a reference to the inboy to load

Returns:

a client for a workflow inbox given its reference

Throws:

com.lexmark.saperion.exceptions.EcmException