org.osid.workflow

Interface WorkflowProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, WorkflowProfile

public interface WorkflowProxyManager
extends OsidProxyManager, WorkflowProfile

The workflow proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• ProcessLookupSession: a session to retrieve processs
• ProcessQuerySession: a session to query for processs
• ProcessSearchSession: a session to search for processs
• ProcessAdminSession: a session to create and delete processs
• ProcessNotificationSession: a session to receive notifications pertaining to process changes
• ProcessOfficeSession: a session to looking mappings of process to offices
• ProcessOfficeAssignmentSession: a session to manage process to office workflows
• ProcessSmartOfficeSession: a session to manage dynamic offices of processs

• StepLookupSession: a session to retrieve steps
• StepQuerySession: a session to query for steps
• StepSearchSession: a session to search for steps
• StepAdminSession: a session to create and delete steps
• StepNotificationSession: a session to receive notifications pertaining to step changes
• StepOfficeSession: a session to look up step office mappings
• StepOfficeAssignmentSession: a session to manage steps to office mappings
• StepSmartOfficeSession: a session to manage dynamic offices of stepss

• WorkLookupSession: a session to retrieve work
• WorkQuerySession: a session to query for work
• WorkSearchSession: a session to search for work
• WorkAdminSession: a session to create and delete work
• WorkNotificationSession: a session to receive notifications pertaining to work changes
• WorkOfficeSession: a session to look up work office mappings
• WorkOfficeAssignmentSession: a session to manage availability to office mappings
• WorkSmartOfficeSession: a session to manage dynamic offices of work

• WorkflowSession: a session to examine work in a process
• WorkflowInitiationSession: a session to start work through a process
• WorkflowManagementSession: a session to enable and disable work in a process
• ManualWorkflowSession: a session to manuall assign work to steps in a process
• WorkflowLogSession: a session to look up changes in a workflow
• WorkflowEventNotificationSession: a session to receive notifications of workflow changes

• OfficeLookupSession: a session to retrieve offices
• OfficeQuerySession: a session to search for offices
• OfficeSearchSession: a session to search for offices
• OfficeAdminSession: a session to create and delete offices
• OfficeNotificationSession: a session to receive notifications pertaining to office changes
• OfficeHierarchySession: a session to traverse a hierarchy of office
• OfficeHierarchyDesignSession: a session to manage a office hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
ManualWorkflowSession	getManualWorkflowSession(Proxy proxy) Gets the OsidSession for a manual workflow service.
ManualWorkflowSession	getManualWorkflowSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession for a manual workflow service for the given office.
OfficeAdminSession	getOfficeAdminSession(Proxy proxy) Gets the OsidSession associated with the office administrative service.
OfficeHierarchyDesignSession	getOfficeHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the office hierarchy design service.
OfficeHierarchySession	getOfficeHierarchySession(Proxy proxy) Gets the OsidSession associated with the office hierarchy service.
OfficeLookupSession	getOfficeLookupSession(Proxy proxy) Gets the OsidSession associated with the office lookup service.
OfficeNotificationSession	getOfficeNotificationSession(OfficeReceiver officeReceiver, Proxy proxy) Gets the OsidSession associated with the office notification service.
OfficeQuerySession	getOfficeQuerySession(Proxy proxy) Gets the OsidSession associated with the office query service.
OfficeSearchSession	getOfficeSearchSession(Proxy proxy) Gets the OsidSession associated with the office search service.
ProcessAdminSession	getProcessAdminSession(Proxy proxy) Gets the OsidSession associated with the process administration service.
ProcessAdminSession	getProcessAdminSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the process administration service for the given office.
ProcessLookupSession	getProcessLookupSession(Proxy proxy) Gets the OsidSession associated with the process lookup service.
ProcessLookupSession	getProcessLookupSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the process lookup service for the given office.
ProcessNotificationSession	getProcessNotificationSession(ProcessReceiver processReceiver, Proxy proxy) Gets the OsidSession associated with the process notification service.
ProcessNotificationSession	getProcessNotificationSessionForOffice(ProcessReceiver processReceiver, Id officeId, Proxy proxy) Gets the OsidSession associated with the process notification service for the given office.
ProcessOfficeAssignmentSession	getProcessOfficeAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning process to offices.
ProcessOfficeSession	getProcessOfficeSession(Proxy proxy) Gets the OsidSession to lookup process/office mappings.
ProcessQuerySession	getProcessQuerySession(Proxy proxy) Gets the OsidSession associated with the process query service.
ProcessQuerySession	getProcessQuerySessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the process query service for the given office.
ProcessSearchSession	getProcessSearchSession(Proxy proxy) Gets the OsidSession associated with the process search service.
ProcessSearchSession	getProcessSearchSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the process search service for the given office.
ProcessSmartOfficeSession	getProcessSmartOfficeSession(Id officeId, Proxy proxy) Gets the OsidSession to manage process smart offices.
StepAdminSession	getStepAdminSession(Proxy proxy) Gets the OsidSession associated with the step administration service.
StepAdminSession	getStepAdminSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the step administration service for the given office.
StepLookupSession	getStepLookupSession(Proxy proxy) Gets the OsidSession associated with the step lookup service.
StepLookupSession	getStepLookupSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the step lookup service for the given office.
StepNotificationSession	getStepNotificationSession(StepReceiver stepReceiver, Proxy proxy) Gets the OsidSession associated with the step notification service.
StepNotificationSession	getStepNotificationSessionForOffice(StepReceiver stepReceiver, Id officeId, Proxy proxy) Gets the OsidSession associated with the step notification service for the given office.
StepOfficeAssignmentSession	getStepOfficeAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning steps to offices.
StepOfficeSession	getStepOfficeSession(Proxy proxy) Gets the OsidSession to lookup step/office mappings.
StepQuerySession	getStepQuerySession(Proxy proxy) Gets the OsidSession associated with the step query service.
StepQuerySession	getStepQuerySessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the step query service for the given office.
StepSearchSession	getStepSearchSession(Proxy proxy) Gets the OsidSession associated with the step search service.
StepSearchSession	getStepSearchSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the step search service for the given office.
StepOfficeSession	getStepSmartOfficeSession(Id officeId, Proxy proxy) Gets the OsidSession to manage step smart offices.
WorkAdminSession	getWorkAdminSession(Proxy proxy) Gets the OsidSession associated with the work administration service.
WorkAdminSession	getWorkAdminSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the work administration service for the given office.
WorkflowBatchProxyManager	getWorkflowBatchProxyManager() Gets a WorkflowBatchProxyManager.
WorkflowEventLookupSession	getWorkflowEventLookupSession(Proxy proxy) Gets the OsidSession for a workflow event lookup service.
WorkflowEventLookupSession	getWorkflowEventLookupSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession for a workflow event lookup service for the given office.
WorkflowEventNotificationSession	getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver, Proxy proxy) Gets the OsidSession associated with the workflow event notification service.
WorkflowEventNotificationSession	getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver, Id officeId, Proxy proxy) Gets the OsidSession associated with the workflow event notification service for the given office.
WorkflowInitiationSession	getWorkflowInitiationSession(Proxy proxy) Gets the OsidSession for a workflow initiation service.
WorkflowInitiationSession	getWorkflowInitiationSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession for a workflow initiation service for the given office.
WorkflowManagementSession	getWorkflowManagementSession(Proxy proxy) Gets the OsidSession for a workflow management service.
WorkflowManagementSession	getWorkflowManagementSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession for a workflow management service for the given office.
WorkflowRulesProxyManager	getWorkflowRulesProxyManager() Gets a WorkflowRulesProxyManager .
WorkflowSession	getWorkflowSession(Proxy proxy) Gets the OsidSession for a workflow service.
WorkflowSession	getWorkflowSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession for a workflow service for the given office.
WorkLookupSession	getWorkLookupSession(Proxy proxy) Gets the OsidSession associated with the work lookup service.
WorkLookupSession	getWorkLookupSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the work lookup service for the given office.
WorkNotificationSession	getWorkNotificationSession(WorkReceiver workReceiver, Proxy proxy) Gets the OsidSession associated with the work notification service.
WorkNotificationSession	getWorkNotificationSessionForOffice(WorkReceiver workReceiver, Id officeId, Proxy proxy) Gets the OsidSession associated with the work notification service for the given office.
WorkOfficeAssignmentSession	getWorkOfficeAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning work to offices.
WorkOfficeSession	getWorkOfficeSession(Proxy proxy) Gets the OsidSession to lookup work/office mappings.
WorkQuerySession	getWorkQuerySession(Proxy proxy) Gets the OsidSession associated with the work query service.
WorkQuerySession	getWorkQuerySessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the work query service for the given office.
WorkSearchSession	getWorkSearchSession(Proxy proxy) Gets the OsidSession associated with the work search service.
WorkSearchSession	getWorkSearchSessionForOffice(Id officeId, Proxy proxy) Gets the OsidSession associated with the work search service for the given office.
WorkSmartOfficeSession	getWorkSmartOfficeSession(Id officeId, Proxy proxy) Gets the OsidSession to manage work smart offices.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.workflow.WorkflowProfile

getOfficeRecordTypes, getOfficeSearchRecordTypes, getProcessRecordTypes, getProcessSearchRecordTypes, getStepRecordTypes, getStepSearchRecordTypes, getWorkflowEventRecordTypes, getWorkRecordTypes, getWorkSearchRecordTypes, supportsManualWorkflow, supportsOfficeAdmin, supportsOfficeHierarchy, supportsOfficeHierarchyDesign, supportsOfficeLookup, supportsOfficeNotification, supportsOfficeQuery, supportsOfficeRecordType, supportsOfficeSearch, supportsOfficeSearchRecordType, supportsProcessAdmin, supportsProcessLookup, supportsProcessNotification, supportsProcessOffice, supportsProcessOfficeAssignment, supportsProcessQuery, supportsProcessRecordType, supportsProcessSearch, supportsProcessSearchRecordType, supportsProcessSmartOffice, supportsStepAdmin, supportsStepLookup, supportsStepNotification, supportsStepOffice, supportsStepOfficeAssignment, supportsStepQuery, supportsStepRecordType, supportsStepSearch, supportsStepSearchRecordType, supportsStepSmartOffice, supportsVisibleFederation, supportsWorkAdmin, supportsWorkflow, supportsWorkflowBatch, supportsWorkflowEventLookup, supportsWorkflowEventNotification, supportsWorkflowEventRecordType, supportsWorkflowInitiation, supportsWorkflowManagement, supportsWorkflowRules, supportsWorkLookup, supportsWorkNotification, supportsWorkOffice, supportsWorkOfficeAssignment, supportsWorkQuery, supportsWorkRecordType, supportsWorkSearch, supportsWorkSearchRecordType, supportsWorkSmartOffice

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getProcessLookupSession

ProcessLookupSession getProcessLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the process lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() is false

Compliance:

optional - This method must be implemented if supportsProcessLookup() is true.

getProcessLookupSessionForOffice

ProcessLookupSession getProcessLookupSessionForOffice(Id officeId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the process lookup service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessLookup() and supportsVisibleFederation() are true

getProcessQuerySession

ProcessQuerySession getProcessQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the process query service.

Parameters:

proxy - a proxy

Returns:

a ProcessQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() is false

Compliance:

optional - This method must be implemented if supportsProcessQuery() is true.

getProcessQuerySessionForOffice

ProcessQuerySession getProcessQuerySessionForOffice(Id officeId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the process query service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessQuery() and supportsVisibleFederation() are true

getProcessSearchSession

ProcessSearchSession getProcessSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the process search service.

Parameters:

proxy - a proxy

Returns:

a ProcessSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() is false

Compliance:

optional - This method must be implemented if supportsProcessSearch() is true.

getProcessSearchSessionForOffice

ProcessSearchSession getProcessSearchSessionForOffice(Id officeId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the process search service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessSearch() and supportsVisibleFederation() are true

getProcessAdminSession

ProcessAdminSession getProcessAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the process administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessAdmin() is false

Compliance:

optional - This method must be implemented if supportsProcessAdmin() is true.

getProcessAdminSessionForOffice

ProcessAdminSession getProcessAdminSessionForOffice(Id officeId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the process administration service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessAdmin() and supportsVisibleFederation() are true

getProcessNotificationSession

ProcessNotificationSession getProcessNotificationSession(ProcessReceiver processReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the process notification service.

Parameters:

processReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessNotificationSession

Throws:

NullArgumentException - processReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessNotification() is false

Compliance:

optional - This method must be implemented if supportsProcessNotification() is true.

getProcessNotificationSessionForOffice

ProcessNotificationSession getProcessNotificationSessionForOffice(ProcessReceiver processReceiver,
                                                                Id officeId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the process notification service for the given office.

Parameters:

processReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessNotification() and supportsVisibleFederation() are true

getProcessOfficeSession

ProcessOfficeSession getProcessOfficeSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup process/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessOffice() is false

Compliance:

optional - This method must be implemented if supportsProcessOffice() is true.

getProcessOfficeAssignmentSession

ProcessOfficeAssignmentSession getProcessOfficeAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning process to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessOfficeAssignment() is false

Compliance:

optional - This method must be implemented if supportsProcessOfficeAssignment() is true.

getProcessSmartOfficeSession

ProcessSmartOfficeSession getProcessSmartOfficeSession(Id officeId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession to manage process smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSmartOffice() is false

Compliance:

optional - This method must be implemented if supportsProcessSmartOffice() is true.

getStepLookupSession

StepLookupSession getStepLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the step lookup service.

Parameters:

proxy - a proxy

Returns:

an StepLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepLookup() is false

Compliance:

optional - This method must be implemented if supportsStepLookup() is true.

getStepLookupSessionForOffice

StepLookupSession getStepLookupSessionForOffice(Id officeId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the step lookup service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStepLookup() and supportsVisibleFederation() are true

getStepQuerySession

StepQuerySession getStepQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the step query service.

Parameters:

proxy - a proxy

Returns:

an StepQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepQuery() is false

Compliance:

optional - This method must be implemented if supportsStepQuery() is true.

getStepQuerySessionForOffice

StepQuerySession getStepQuerySessionForOffice(Id officeId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets the OsidSession associated with the step query service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStepQuery() and supportsVisibleFederation() are true

getStepSearchSession

StepSearchSession getStepSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the step search service.

Parameters:

proxy - a proxy

Returns:

an StepSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSearch() is false

Compliance:

optional - This method must be implemented if supportsStepSearch() is true.

getStepSearchSessionForOffice

StepSearchSession getStepSearchSessionForOffice(Id officeId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the step search service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStepSearch() and supportsVisibleFederation() are true

getStepAdminSession

StepAdminSession getStepAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the step administration service.

Parameters:

proxy - a proxy

Returns:

an StepAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepAdmin() is false

Compliance:

optional - This method must be implemented if supportsStepAdmin() is true.

getStepAdminSessionForOffice

StepAdminSession getStepAdminSessionForOffice(Id officeId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets the OsidSession associated with the step administration service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStepAdmin() and supportsVisibleFederation() are true

getStepNotificationSession

StepNotificationSession getStepNotificationSession(StepReceiver stepReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the step notification service.

Parameters:

stepReceiver - the notification callback

proxy - a proxy

Returns:

an StepNotificationSession

Throws:

NullArgumentException - stepReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepNotification() is false

Compliance:

optional - This method must be implemented if supportsStepNotification() is true.

getStepNotificationSessionForOffice

StepNotificationSession getStepNotificationSessionForOffice(StepReceiver stepReceiver,
                                                          Id officeId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the step notification service for the given office.

Parameters:

stepReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStepNotification() and supportsVisibleFederation() are true

getStepOfficeSession

StepOfficeSession getStepOfficeSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession to lookup step/office mappings.

Parameters:

proxy - a proxy

Returns:

an StepOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepOffice() is false

Compliance:

optional - This method must be implemented if supportsStepOffice() is true.

getStepOfficeAssignmentSession

StepOfficeAssignmentSession getStepOfficeAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with assigning steps to offices.

Parameters:

proxy - a proxy

Returns:

an StepOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepOfficeAssignment() is false

Compliance:

optional - This method must be implemented if supportsStepOfficeAssignment() is true.

getStepSmartOfficeSession

StepOfficeSession getStepSmartOfficeSession(Id officeId,
                                          Proxy proxy)
                                            throws NotFoundException,
                                                   OperationFailedException

Gets the OsidSession to manage step smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

an StepSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSmartOffice() is false

Compliance:

optional - This method must be implemented if supportsStepSmartOffice() is true.

getWorkLookupSession

WorkLookupSession getWorkLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the work lookup service.

Parameters:

proxy - a proxy

Returns:

a WorkLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() is false

Compliance:

optional - This method must be implemented if supportsWorkLookup() is true.

getWorkLookupSessionForOffice

WorkLookupSession getWorkLookupSessionForOffice(Id officeId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the work lookup service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkLookup() and supportsVisibleFederation() are true

getWorkQuerySession

WorkQuerySession getWorkQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the work query service.

Parameters:

proxy - a proxy

Returns:

a WorkQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() is false

Compliance:

optional - This method must be implemented if supportsWorkQuery() is true.

getWorkQuerySessionForOffice

WorkQuerySession getWorkQuerySessionForOffice(Id officeId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets the OsidSession associated with the work query service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkQuery() and supportsVisibleFederation() are true

getWorkSearchSession

WorkSearchSession getWorkSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the work search service.

Parameters:

proxy - a proxy

Returns:

a WorkSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() is false

Compliance:

optional - This method must be implemented if supportsWorkSearch() is true.

getWorkSearchSessionForOffice

WorkSearchSession getWorkSearchSessionForOffice(Id officeId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the work search service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkSearch() and supportsVisibleFederation() are true

getWorkAdminSession

WorkAdminSession getWorkAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the work administration service.

Parameters:

proxy - a proxy

Returns:

a WorkAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() is false

Compliance:

optional - This method must be implemented if supportsWorkAdmin() is true.

getWorkAdminSessionForOffice

WorkAdminSession getWorkAdminSessionForOffice(Id officeId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets the OsidSession associated with the work administration service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkAdmin() and supportsVisibleFederation() are true

getWorkNotificationSession

WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the work notification service.

Parameters:

workReceiver - the notification callback

proxy - a proxy

Returns:

a WorkNotificationSession

Throws:

NullArgumentException - workReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() is false

Compliance:

optional - This method must be implemented if supportsWorkNotification() is true.

getWorkNotificationSessionForOffice

WorkNotificationSession getWorkNotificationSessionForOffice(WorkReceiver workReceiver,
                                                          Id officeId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the work notification service for the given office.

Parameters:

workReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - workReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkNotification() and supportsVisibleFederation() are true

getWorkOfficeSession

WorkOfficeSession getWorkOfficeSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession to lookup work/office mappings.

Parameters:

proxy - a proxy

Returns:

a WorkOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkOffice() is false

Compliance:

optional - This method must be implemented if supportsWorkOffice() is true.

getWorkOfficeAssignmentSession

WorkOfficeAssignmentSession getWorkOfficeAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with assigning work to offices.

Parameters:

proxy - a proxy

Returns:

a WorkOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkbOfficeAssignment() is false

Compliance:

optional - This method must be implemented if supportsWorkOfficeAssignment() is true.

getWorkSmartOfficeSession

WorkSmartOfficeSession getWorkSmartOfficeSession(Id officeId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession to manage work smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - no Office found by the given Id

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSmartOffice() is false

Compliance:

optional - This method must be implemented if supportsWorkSmartOffice() is true.

getWorkflowSession

WorkflowSession getWorkflowSession(Proxy proxy)
                                   throws OperationFailedException

Gets the OsidSession for a workflow service.

Parameters:

proxy - a proxy

Returns:

a WorkflowSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflow() is false

Compliance:

optional - This method must be implemented if supportsWorkflow() is true.

getWorkflowSessionForOffice

WorkflowSession getWorkflowSessionForOffice(Id officeId,
                                          Proxy proxy)
                                            throws NotFoundException,
                                                   OperationFailedException

Gets the OsidSession for a workflow service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkflowSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflow() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkflow() and supportsVisibleFederation() are true

getWorkflowInitiationSession

WorkflowInitiationSession getWorkflowInitiationSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession for a workflow initiation service.

Parameters:

proxy - a proxy

Returns:

a WorkflowInitiationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowInitiation() is false

Compliance:

optional - This method must be implemented if supportsWorkflowInitiation() is true.

getWorkflowInitiationSessionForOffice

WorkflowInitiationSession getWorkflowInitiationSessionForOffice(Id officeId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession for a workflow initiation service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkflowInitiationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowInitiation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkflowInitiation() and supportsVisibleFederation() are true

getWorkflowManagementSession

WorkflowManagementSession getWorkflowManagementSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession for a workflow management service.

Parameters:

proxy - a proxy

Returns:

a WorkflowManagementSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowManagement() is false

Compliance:

optional - This method must be implemented if supportsWorkflowManagement() is true.

getWorkflowManagementSessionForOffice

WorkflowManagementSession getWorkflowManagementSessionForOffice(Id officeId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession for a workflow management service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkflowManagementSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowManagement() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkflowManagement() and supportsVisibleFederation() are true

getManualWorkflowSession

ManualWorkflowSession getManualWorkflowSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession for a manual workflow service.

Parameters:

proxy - a proxy

Returns:

a ManualWorkflowSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsManualWorkflow() is false

Compliance:

optional - This method must be implemented if supportsManualWorkflow() is true.

getManualWorkflowSessionForOffice

ManualWorkflowSession getManualWorkflowSessionForOffice(Id officeId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession for a manual workflow service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ManualWorkflowSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsManualWorkflow() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsManualWorkflow() and supportsVisibleFederation() are true

getWorkflowEventLookupSession

WorkflowEventLookupSession getWorkflowEventLookupSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession for a workflow event lookup service.

Parameters:

proxy - a proxy

Returns:

a WorkflowEventLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventLookup() is false

Compliance:

optional - This method must be implemented if supportsWorkflowEventLookup() is true.

getWorkflowEventLookupSessionForOffice

WorkflowEventLookupSession getWorkflowEventLookupSessionForOffice(Id officeId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession for a workflow event lookup service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkflowEventLookupSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkflowEventLookup() and supportsVisibleFederation() are true

getWorkflowEventNotificationSession

WorkflowEventNotificationSession getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver,
                                                                   Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the workflow event notification service.

Parameters:

workflowEventReceiver - the notification callback

proxy - a proxy

Returns:

a WorkflowEventNotificationSession

Throws:

NullArgumentException - workflowEventReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventNotification() is false

Compliance:

optional - This method must be implemented if supportsWorkflowEventNotification() is true

getWorkflowEventNotificationSessionForOffice

WorkflowEventNotificationSession getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver,
                                                                            Id officeId,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the OsidSession associated with the workflow event notification service for the given office.

Parameters:

workflowEventReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkflowEventNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - workflowEventReceiver, officeId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkflowEventNotification() and supportsVisibleFederation() are true

getOfficeLookupSession

OfficeLookupSession getOfficeLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the office lookup service.

Parameters:

proxy - a proxy

Returns:

a OfficeLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeLookup() is false

Compliance:

optional - This method must be implemented if supportsOfficeLookup() is true.

getOfficeQuerySession

OfficeQuerySession getOfficeQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the office query service.

Parameters:

proxy - a proxy

Returns:

a OfficeQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeQuery() is false

Compliance:

optional - This method must be implemented if supportsOfficeQuery() is true.

getOfficeSearchSession

OfficeSearchSession getOfficeSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the office search service.

Parameters:

proxy - a proxy

Returns:

a OfficeSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeSearch() is false

Compliance:

optional - This method must be implemented if supportsOfficeSearch() is true.

getOfficeAdminSession

OfficeAdminSession getOfficeAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the office administrative service.

Parameters:

proxy - a proxy

Returns:

a OfficeAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeAdmin() is false

Compliance:

optional - This method must be implemented if supportsOfficeAdmin() is true.

getOfficeNotificationSession

OfficeNotificationSession getOfficeNotificationSession(OfficeReceiver officeReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the office notification service.

Parameters:

officeReceiver - the notification callback

proxy - a proxy

Returns:

a OfficeNotificationSession

Throws:

NullArgumentException - officeReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeNotification() is false

Compliance:

optional - This method must be implemented if supportsOfficeNotification() is true.

getOfficeHierarchySession

OfficeHierarchySession getOfficeHierarchySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the office hierarchy service.

Parameters:

proxy - a proxy

Returns:

a OfficeHierarchySession for offices

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeHierarchy() is false

Compliance:

optional - This method must be implemented if supportsOfficeHierarchy() is true.

getOfficeHierarchyDesignSession

OfficeHierarchyDesignSession getOfficeHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the office hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for offices

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsOfficeHierarchyDesign() is true.

getWorkflowBatchProxyManager

WorkflowBatchProxyManager getWorkflowBatchProxyManager()
                                                       throws OperationFailedException

Gets a WorkflowBatchProxyManager.

Returns:

a WorkflowbatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowBatch() is false

Compliance:

optional - This method must be implemented if supportsWorkflowBatch() is true.

getWorkflowRulesProxyManager

WorkflowRulesProxyManager getWorkflowRulesProxyManager()
                                                       throws OperationFailedException

Gets a WorkflowRulesProxyManager .

Returns:

a WorkflowRulesProxyManager for offices

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowRules() is false

Compliance:

optional - This method must be implemented if supportsWorkflowRules() is true.