Interface WorkflowRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, WorkflowRulesProfile

public interface WorkflowRulesProxyManager
extends OsidProxyManager, WorkflowRulesProfile

The workflow rules proxy manager provides access to workflow 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:

• ProcessEnablerLookupSession : a session to retrieve process enablers
• ProcessEnablerQuerySession : a session to query for process enablers
• ProcessEnablerSearchSession : a session to search for process enablers
• ProcessEnablerAdminSession : a session to create and delete process enablers
• ProcessEnablerNotificationSession : a session to receive notifications pertaining to process enabler changes
• ProcessEnablerOfficeSession : a session to look up process enabler office mappings
• ProcessEnablerOfficeAssignmentSession : a session to manage process enabler to office mappings
• ProcessEnablerSmartOfficeSession : a session to manage dynamic offices of process enablers
• ProcessEnablerRuleLookupSession : a session to look up process enablers to process mappings
• ProcessEnablerRuleApplicationSession: a session to apply process enablers to processes

• ProcessConstrainerLookupSession : a session to retrieve process constrainers
• ProcessConstrainerQuerySession : a session to query for process constrainers
• ProcessConstrainerSearchSession : a session to search for process constrainers
• ProcessConstrainerAdminSession : a session to create and delete process constrainers
• ProcessConstrainerNotificationSession : a session to receive notifications pertaining to process constrainer changes
• ProcessConstrainerOfficeSession : a session to look up process constrainer office mappings
• ProcessConstrainerOfficeAssignmentSession : a session to manage process constrainer to office mappings
• ProcessConstrainerSmartOfficeSession : a session to manage dynamic offices of process constrainers
• ProcessConstrainerRuleLookupSession : a session to look up process constrainers to process mappings
• ProcessConstrainerRuleApplicationSession: a session to apply process constrainers to processes

• ProcessConstrainerEnablerLookupSession : a session to retrieve process constrainer enablers
• ProcessConstrainerEnablerQuerySession : a session to query for process constrainer enablers
• ProcessConstrainerEnablerSearchSession : a session to search for process constrainer enablers
• ProcessConstrainerEnablerAdminSession : a session to create and delete process constrainer enablers
• ProcessConstrainerEnablerNotificationSession : a session to receive notifications pertaining to process constrainer enabler changes
• ProcessConstrainerEnablerOfficeSession : a session to look up process constrainer enabler office mappings
• ProcessConstrainerEnablerOfficeAssignmentSession : a session to manage process constrainer enabler to office mappings
• ProcessConstrainerEnablerSmartOfficeSession : a session to manage dynamic offices of process constrainer enablers
• ProcessConstrainerEnablerRuleLookupSession : a session to look up process constrainer enablers to process constrainer mappings
• ProcessConstrainerEnablerRuleApplicationSession: a session to apply process constrainer enablers to process constrainers

• ProcessProcessorLookupSession : a session to retrieve process processors
• ProcessProcessorQuerySession : a session to query for process processors
• ProcessProcessorSearchSession : a session to search for process processors
• ProcessProcessorAdminSession : a session to create and delete process processors
• ProcessProcessorNotificationSession : a session to receive notifications pertaining to process processor changes
• ProcessProcessorOfficeSession : a session to look up process processor office mappings
• ProcessProcessorOfficeAssignmentSession : a session to manage process processor to office mappings
• ProcessProcessorSmartOfficeSession : a session to manage dynamic offices of process processors
• ProcessProcessorRuleLookupSession : a session to look up process processors to process mappings
• ProcessProcessorRuleApplicationSession: a session to apply process processors to processes

• ProcessProcessorEnablerLookupSession : a session to retrieve process processor enablers
• ProcessProcessorEnablerQuerySession : a session to query for process processor enablers
• ProcessProcessorEnablerSearchSession : a session to search for process processor enablers
• ProcessProcessorEnablerAdminSession : a session to create and delete process processor enablers
• ProcessProcessorEnablerNotificationSession : a session to receive notifications pertaining to process processor enabler changes
• ProcessProcessorEnablerOfficeSession : a session to look up process processor enabler office mappings
• ProcessProcessorEnablerOfficeAssignmentSession : a session to manage process processor enabler to office mappings
• ProcessProcessorEnablerSmartOfficeSession : a session to manage dynamic offices of process processor enablers
• ProcessProcessorEnablerRuleLookupSession : a session to look up process processor enablers to process processor mappings
• ProcessProcessorEnablerRuleApplicationSession: a session to apply process processor enablers to process processors

• StepEnablerLookupSession : a session to retrieve step enablers
• StepEnablerQuerySession : a session to query for step enablers
• StepEnablerSearchSession : a session to search for step enablers
• StepEnablerAdminSession : a session to create and delete step enablers
• StepEnablerNotificationSession : a session to receive notifications pertaining to step enabler changes
• StepEnablerOfficeSession : a session to look up step enabler office mappings
• StepEnablerOfficeAssignmentSession : a session to manage step enabler to office mappings
• StepEnablerSmartOfficeSession : a session to manage dynamic offices of step enablers
• StepEnablerRuleLookupSession : a session to look up step enablers to step mappings
• StepEnablerRuleApplicationSession: a session to apply step enablers to steps

• StepConstrainerLookupSession : a session to retrieve step constrainer
• StepConstrainerQuerySession : a session to query for step constrainer
• StepConstrainerSearchSession : a session to search for step constrainer
• StepConstrainerAdminSession : a session to create and delete step constrainer
• StepConstrainerNotificationSession : a session to receive notifications pertaining to step constrainer changes
• StepConstrainerOfficeSession : a session to look up step constrainer office mappings
• StepConstrainerOfficeAssignmentSession : a session to manage step constrainer to office mappings
• StepConstrainerSmartOfficeSession : a session to manage dynamic office of step constrainer
• StepConstrainerRuleLookupSession : a session to look up step constrainer to step mappings
• StepConstrainerRuleApplicationSession : a session to apply step constrainer to stepss

• StepConstrainerEnablerLookupSession : a session to retrieve step constrainer enablers
• StepConstrainerEnablerQuerySession : a session to query for step constrainer enablers
• StepConstrainerEnablerSearchSession : a session to search for step constrainer enablers
• StepConstrainerEnablerAdminSession : a session to create and delete step constrainer enablers
• StepConstrainerEnablerNotificationSession : a session to receive notifications pertaining to step constrainer enabler changes
• StepConstrainerEnablerOfficeSession : a session to look up step constrainer enabler office mappings
• StepConstrainerEnablerOfficeAssignmentSession : a session to manage step constrainer enabler to office mappings
• StepConstrainerEnablerSmartOfficeSession : a session to manage dynamic office of step constrainer enablers
• StepConstrainerEnableRuleLookupSession : a session to look up step constrainer enabler mappings
• StepConstrainerEnablerRuleApplicationSession : a session to apply step constrainer enablers

• StepProcessorLookupSession : a session to retrieve step processor
• StepProcessorQuerySession : a session to query for step processor
• StepProcessorSearchSession : a session to search for step processor
• StepProcessorAdminSession : a session to create and delete step processor
• StepProcessorNotificationSession : a session to receive notifications pertaining to step processor changes
• StepProcessorOfficeSession : a session to look up step processor office mappings
• StepProcessorOfficeAssignmentSession : a session to manage step processor to office mappings
• StepProcessorSmartOfficeSession : a session to manage dynamic office of step processor
• StepProcessorRuleLookupSession : a session to look up step processor to step mappings
• StepProcessorRuleApplicationSession : a session to apply step processor to stepss

• StepProcessorEnablerLookupSession : a session to retrieve step processor enablers
• StepProcessorEnablerQuerySession : a session to query for step processor enablers
• StepProcessorEnablerSearchSession : a session to search for step processor enablers
• StepProcessorEnablerAdminSession : a session to create and delete step processor enablers
• StepProcessorEnablerNotificationSession : a session to receive notifications pertaining to step processor enabler changes
• StepProcessorEnablerOfficeSession : a session to look up step processor enabler office mappings
• StepProcessorEnablerOfficeAssignmentSession : a session to manage step processor enabler to office mappings
• StepProcessorEnablerSmartOfficeSession : a session to manage dynamic office of step processor enablers
• StepProcessorEnablerRuleLookupSession : a session to look up step processor enabler mappings
• StepProcessorEnablerRuleApplicationSession : a session to apply step processor enablers

Method Summary

Modifier and Type	Method	Description
ProcessConstrainerAdminSession	getProcessConstrainerAdminSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer administration service.
ProcessConstrainerAdminSession	getProcessConstrainerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer administration service for the given office.
ProcessConstrainerEnablerAdminSession	getProcessConstrainerEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler administration service.
ProcessConstrainerEnablerAdminSession	getProcessConstrainerEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler administration service for the given office.
ProcessConstrainerEnablerLookupSession	getProcessConstrainerEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler lookup service.
ProcessConstrainerEnablerLookupSession	getProcessConstrainerEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler lookup service for the given office.
ProcessConstrainerEnablerNotificationSession	getProcessConstrainerEnablerNotificationSession(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler notification service.
ProcessConstrainerEnablerNotificationSession	getProcessConstrainerEnablerNotificationSessionForOffice(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler notification service for the given office.
ProcessConstrainerEnablerOfficeAssignmentSession	getProcessConstrainerEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning process constrainer enablers to offices.
ProcessConstrainerEnablerOfficeSession	getProcessConstrainerEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup process constrainer enabler/office mappings.
ProcessConstrainerEnablerQuerySession	getProcessConstrainerEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler query service.
ProcessConstrainerEnablerQuerySession	getProcessConstrainerEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler query service for the given office.
ProcessConstrainerEnablerRuleApplicationSession	getProcessConstrainerEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler assignment service to apply to process constrainers.
ProcessConstrainerEnablerRuleApplicationSession	getProcessConstrainerEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler assignment service for the given office to apply to process constrainers.
ProcessConstrainerEnablerRuleLookupSession	getProcessConstrainerEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler process mapping lookup service for looking up the rules applied to a process constrainer.
ProcessConstrainerEnablerRuleLookupSession	getProcessConstrainerEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler mapping lookup service for the given office for looking up rules applied to a process constrainer.
ProcessConstrainerEnablerSearchSession	getProcessConstrainerEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler search service.
ProcessConstrainerEnablerSearchSession	getProcessConstrainerEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer enabler search service for the given office.
ProcessConstrainerEnablerSmartOfficeSession	getProcessConstrainerEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage process constrainer enabler smart offices.
ProcessConstrainerLookupSession	getProcessConstrainerLookupSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer lookup service.
ProcessConstrainerLookupSession	getProcessConstrainerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer lookup service for the given office.
ProcessConstrainerNotificationSession	getProcessConstrainerNotificationSession(ProcessConstrainerReceiver processConstrainerReceiver, Proxy proxy)	Gets the OsidSession associated with the process constrainer notification service.
ProcessConstrainerNotificationSession	getProcessConstrainerNotificationSessionForOffice(ProcessConstrainerReceiver processConstrainerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer notification service for the given office.
ProcessConstrainerOfficeAssignmentSession	getProcessConstrainerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning process constrainers to offices.
ProcessConstrainerOfficeSession	getProcessConstrainerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup process constrainer/office mappings.
ProcessConstrainerQuerySession	getProcessConstrainerQuerySession(Proxy proxy)	Gets the OsidSession associated with the process constrainer query service.
ProcessConstrainerQuerySession	getProcessConstrainerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer query service for the given office.
ProcessConstrainerRuleApplicationSession	getProcessConstrainerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer assignment service to apply to processes.
ProcessConstrainerRuleApplicationSession	getProcessConstrainerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer assignment service for the given office to apply to processes.
ProcessConstrainerRuleLookupSession	getProcessConstrainerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer process mapping lookup service for looking up the rules applied to a process.
ProcessConstrainerRuleLookupSession	getProcessConstrainerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer mapping lookup service for the given office for looking up rules applied to a process
ProcessConstrainerSearchSession	getProcessConstrainerSearchSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer search service.
ProcessConstrainerSearchSession	getProcessConstrainerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process constrainer search service for the given office.
ProcessConstrainerSmartOfficeSession	getProcessConstrainerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage process constrainer smart offices.
ProcessEnablerAdminSession	getProcessEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the process enabler administration service.
ProcessEnablerAdminSession	getProcessEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler administration service for the given office.
ProcessEnablerLookupSession	getProcessEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the process enabler lookup service.
ProcessEnablerLookupSession	getProcessEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler lookup service for the given office.
ProcessEnablerNotificationSession	getProcessEnablerNotificationSession(ProcessEnablerReceiver processEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the process enabler notification service.
ProcessEnablerNotificationSession	getProcessEnablerNotificationSessionForOffice(ProcessEnablerReceiver processEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler notification service for the given office.
ProcessEnablerOfficeAssignmentSession	getProcessEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning process enablers to offices.
ProcessEnablerOfficeSession	getProcessEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup process enabler/office mappings.
ProcessEnablerQuerySession	getProcessEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the process enabler query service.
ProcessEnablerQuerySession	getProcessEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler query service for the given office.
ProcessEnablerRuleApplicationSession	getProcessEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the process constrainer assignment service to apply to processes.
ProcessEnablerRuleApplicationSession	getProcessEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler assignment service for the given office to apply to processes.
ProcessEnablerRuleLookupSession	getProcessEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the process enabler process mapping lookup service for looking up the rules applied to a process.
ProcessEnablerRuleLookupSession	getProcessEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler mapping lookup service for the given office for looking up rules applied to a process.
ProcessEnablerSearchSession	getProcessEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the process enabler search service.
ProcessEnablerSearchSession	getProcessEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process enabler search service for the given office.
ProcessEnablerSmartOfficeSession	getProcessEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage process enabler smart offices.
ProcessProcessorAdminSession	getProcessProcessorAdminSession(Proxy proxy)	Gets the OsidSession associated with the process processor administration service.
ProcessProcessorAdminSession	getProcessProcessorAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor administration service for the given office.
ProcessProcessorEnablerAdminSession	getProcessProcessorEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler administration service.
ProcessProcessorEnablerAdminSession	getProcessProcessorEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler administration service for the given office.
ProcessProcessorEnablerLookupSession	getProcessProcessorEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler lookup service.
ProcessProcessorEnablerLookupSession	getProcessProcessorEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler lookup service for the given office.
ProcessProcessorEnablerNotificationSession	getProcessProcessorEnablerNotificationSession(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the process processor enabler notification service.
ProcessProcessorEnablerNotificationSession	getProcessProcessorEnablerNotificationSessionForOffice(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler notification service for the given office.
ProcessProcessorEnablerOfficeAssignmentSession	getProcessProcessorEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning process processors enablers to offices.
ProcessProcessorEnablerOfficeSession	getProcessProcessorEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup process processor enabler/office mappings.
ProcessProcessorEnablerQuerySession	getProcessProcessorEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler query service.
ProcessProcessorEnablerQuerySession	getProcessProcessorEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler query service for the given office.
ProcessProcessorEnablerRuleApplicationSession	getProcessProcessorEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler assignment service to apply to process processors.
ProcessProcessorEnablerRuleApplicationSession	getProcessProcessorEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler assignment service for the given office to apply to process processors.
ProcessProcessorEnablerRuleLookupSession	getProcessProcessorEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler process mapping lookup service for looking up the rules applied to a process processor.
ProcessProcessorEnablerRuleLookupSession	getProcessProcessorEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler mapping lookup service for the given office for looking up rules applied to a process processors.
ProcessProcessorEnablerSearchSession	getProcessProcessorEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the process processor enabler search service.
ProcessProcessorEnablerSearchSession	getProcessProcessorEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor enabler search service for the given office.
ProcessProcessorEnablerSmartOfficeSession	getProcessProcessorEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage process processor enabler smart offices.
ProcessProcessorLookupSession	getProcessProcessorLookupSession(Proxy proxy)	Gets the OsidSession associated with the process processor lookup service.
ProcessProcessorLookupSession	getProcessProcessorLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor lookup service for the given office.
ProcessProcessorNotificationSession	getProcessProcessorNotificationSession(ProcessProcessorReceiver processProcessorReceiver, Proxy proxy)	Gets the OsidSession associated with the process processor notification service.
ProcessProcessorNotificationSession	getProcessProcessorNotificationSessionForOffice(ProcessProcessorReceiver processProcessorReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor notification service for the given office.
ProcessProcessorOfficeAssignmentSession	getProcessProcessorOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning process processors to offices.
ProcessProcessorOfficeSession	getProcessProcessorOfficeSession(Proxy proxy)	Gets the OsidSession to lookup process processor/office mappings.
ProcessProcessorQuerySession	getProcessProcessorQuerySession(Proxy proxy)	Gets the OsidSession associated with the process processor query service.
ProcessProcessorQuerySession	getProcessProcessorQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor query service for the given office.
ProcessProcessorRuleApplicationSession	getProcessProcessorRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the process processor assignment service to apply to processes.
ProcessProcessorRuleApplicationSession	getProcessProcessorRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor assignment service for the given office to apply to processes.
ProcessProcessorRuleLookupSession	getProcessProcessorRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the process processor process mapping lookup service for looking up the rules applied to a process.
ProcessProcessorRuleLookupSession	getProcessProcessorRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor mapping lookup service for the given office for looking up rules applied to a processes.
ProcessProcessorSearchSession	getProcessProcessorSearchSession(Proxy proxy)	Gets the OsidSession associated with the process processor search service.
ProcessProcessorSearchSession	getProcessProcessorSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the process processor search service for the given office.
ProcessProcessorSmartOfficeSession	getProcessProcessorSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage process processor smart offices.
StepConstrainerAdminSession	getStepConstrainerAdminSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer administration service.
StepConstrainerAdminSession	getStepConstrainerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer administration service for the given office.
StepConstrainerEnablerAdminSession	getStepConstrainerEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler administration service.
StepConstrainerEnablerAdminSession	getStepConstrainerEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler administration service for the given office.
StepConstrainerEnablerLookupSession	getStepConstrainerEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler lookup service.
StepConstrainerEnablerLookupSession	getStepConstrainerEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler lookup service for the given office.
StepConstrainerEnablerNotificationSession	getStepConstrainerEnablerNotificationSession(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler notification service.
StepConstrainerEnablerNotificationSession	getStepConstrainerEnablerNotificationSessionForOffice(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler notification service for the given office.
StepConstrainerEnablerOfficeAssignmentSession	getStepConstrainerEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning step constrainer enablers to office.
StepConstrainerEnablerOfficeSession	getStepConstrainerEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup step constrainer enabler/office mappings for step constrainer enablers.
StepConstrainerEnablerQuerySession	getStepConstrainerEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler query service.
StepConstrainerEnablerQuerySession	getStepConstrainerEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler query service for the given office.
StepConstrainerEnablerRuleApplicationSession	getStepConstrainerEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler assignment service.
StepConstrainerEnablerRuleApplicationSession	getStepConstrainerEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler assignment service for the given office.
StepConstrainerEnablerRuleLookupSession	getStepConstrainerEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler mapping lookup service .
StepConstrainerEnablerRuleLookupSession	getStepConstrainerEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler mapping lookup service for the given office.
StepConstrainerEnablerSearchSession	getStepConstrainerEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer enabler search service.
StepConstrainerEnablerSearchSession	getStepConstrainerEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer enablers earch service for the given office.
StepConstrainerEnablerSmartOfficeSession	getStepConstrainerEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage step constrainer enabler smart office.
StepConstrainerLookupSession	getStepConstrainerLookupSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer lookup service.
StepConstrainerLookupSession	getStepConstrainerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer lookup service for the given office.
StepConstrainerNotificationSession	getStepConstrainerNotificationSession(StepConstrainerReceiver stepConstrainerReceiver, Proxy proxy)	Gets the OsidSession associated with the step constrainer notification service.
StepConstrainerNotificationSession	getStepConstrainerNotificationSessionForOffice(StepConstrainerReceiver stepConstrainerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer notification service for the given office.
StepConstrainerOfficeAssignmentSession	getStepConstrainerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning step constrainer to office.
StepConstrainerOfficeSession	getStepConstrainerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup step constrainer/office mappings for step constrainers.
StepConstrainerQuerySession	getStepConstrainerQuerySession(Proxy proxy)	Gets the OsidSession associated with the step constrainer query service.
StepConstrainerQuerySession	getStepConstrainerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer query service for the given office.
StepConstrainerRuleApplicationSession	getStepConstrainerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer assignment service to apply to steps.
StepConstrainerRuleApplicationSession	getStepConstrainerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer assignment service for the given office to apply to steps.
StepConstrainerRuleLookupSession	getStepConstrainerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer mapping lookup service for looking up the rules applied to ta step.
StepConstrainerRuleLookupSession	getStepConstrainerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer mapping lookup service for the given office for looking up rules applied to a qeue.
StepConstrainerSearchSession	getStepConstrainerSearchSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer search service.
StepConstrainerSearchSession	getStepConstrainerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step constrainer earch service for the given office.
StepConstrainerSmartOfficeSession	getStepConstrainerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage step constrainer smart office.
StepEnablerAdminSession	getStepEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the step enabler administration service.
StepEnablerAdminSession	getStepEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler administration service for the given office.
StepEnablerLookupSession	getStepEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the step enabler lookup service.
StepEnablerLookupSession	getStepEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler lookup service for the given office.
StepEnablerNotificationSession	getStepEnablerNotificationSession(StepEnablerReceiver stepEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the step enabler notification service.
StepEnablerNotificationSession	getStepEnablerNotificationSessionForOffice(StepEnablerReceiver stepEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler notification service for the given office.
StepEnablerOfficeAssignmentSession	getStepEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning step enablers to offices.
StepEnablerOfficeSession	getStepEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup step enabler/office mappings.
StepEnablerQuerySession	getStepEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the step enabler query service.
StepEnablerQuerySession	getStepEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler query service for the given office.
StepEnablerRuleApplicationSession	getStepEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the step constrainer assignment service to apply to steps.
StepEnablerRuleApplicationSession	getStepEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler assignment service for the given office to apply to steps.
StepEnablerRuleLookupSession	getStepEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the step enabler step mapping lookup service for looking up the rules applied to a step.
StepEnablerRuleLookupSession	getStepEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler mapping lookup service for the given office for looking up rules applied to a step.
StepEnablerSearchSession	getStepEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the step enabler search service.
StepEnablerSearchSession	getStepEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step enabler search service for the given office.
StepEnablerSmartOfficeSession	getStepEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage step enabler smart offices.
StepProcessorAdminSession	getStepProcessorAdminSession(Proxy proxy)	Gets the OsidSession associated with the step processor administration service.
StepProcessorAdminSession	getStepProcessorAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor administration service for the given office.
StepProcessorEnablerAdminSession	getStepProcessorEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler administration service.
StepProcessorEnablerAdminSession	getStepProcessorEnablerAdminSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler administration service for the given office.
StepProcessorEnablerLookupSession	getStepProcessorEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler lookup service.
StepProcessorEnablerLookupSession	getStepProcessorEnablerLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler lookup service for the given office.
StepProcessorEnablerNotificationSession	getStepProcessorEnablerNotificationSession(StepProcessorEnablerReceiver stepProcessorEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the step processor enabler notification service.
StepProcessorEnablerNotificationSession	getStepProcessorEnablerNotificationSessionForOffice(StepProcessorEnablerReceiver stepProcessorEnablerReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler notification service for the given office.
StepProcessorEnablerOfficeAssignmentSession	getStepProcessorEnablerOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning step processor enablers to step processors.
StepProcessorEnablerOfficeSession	getStepProcessorEnablerOfficeSession(Proxy proxy)	Gets the OsidSession to lookup step processor enabler/office mappings for step processor enablers.
StepProcessorEnablerQuerySession	getStepProcessorEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler query service.
StepProcessorEnablerQuerySession	getStepProcessorEnablerQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler query service for the given office.
StepProcessorEnablerRuleApplicationSession	getStepProcessorEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler assignment service.
StepProcessorEnablerRuleApplicationSession	getStepProcessorEnablerRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler assignment service for the given office.
StepProcessorEnablerRuleLookupSession	getStepProcessorEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler mapping lookup service.
StepProcessorEnablerRuleLookupSession	getStepProcessorEnablerRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enabler mapping lookup service for the given office.
StepProcessorEnablerSearchSession	getStepProcessorEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the step processor enabler search service.
StepProcessorEnablerSearchSession	getStepProcessorEnablerSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor enablers earch service for the given office.
StepProcessorEnablerSmartOfficeSession	getStepProcessorEnablerSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage step processor enabler smart office.
StepProcessorLookupSession	getStepProcessorLookupSession(Proxy proxy)	Gets the OsidSession associated with the step processor lookup service.
StepProcessorLookupSession	getStepProcessorLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor lookup service for the given office.
StepProcessorNotificationSession	getStepProcessorNotificationSession(StepProcessorReceiver stepProcessorReceiver, Proxy proxy)	Gets the OsidSession associated with the step processor notification service.
StepProcessorNotificationSession	getStepProcessorNotificationSessionForOffice(StepProcessorReceiver stepProcessorReceiver, Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor notification service for the given office.
StepProcessorOfficeAssignmentSession	getStepProcessorOfficeAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning step processor to office.
StepProcessorOfficeSession	getStepProcessorOfficeSession(Proxy proxy)	Gets the OsidSession to lookup step processor/office mappings for step processors.
StepProcessorQuerySession	getStepProcessorQuerySession(Proxy proxy)	Gets the OsidSession associated with the step processor query service.
StepProcessorQuerySession	getStepProcessorQuerySessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor query service for the given office.
StepProcessorRuleApplicationSession	getStepProcessorRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the step processor assignment service to apply to steps.
StepProcessorRuleApplicationSession	getStepProcessorRuleApplicationSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor assignment service for the given office to apply to steps.
StepProcessorRuleLookupSession	getStepProcessorRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the step processor mapping lookup service for looking up the rules applied to a step processor.
StepProcessorRuleLookupSession	getStepProcessorRuleLookupSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor mapping lookup service for the given office for looking up rules applied to a step.
StepProcessorSearchSession	getStepProcessorSearchSession(Proxy proxy)	Gets the OsidSession associated with the step processor search service.
StepProcessorSearchSession	getStepProcessorSearchSessionForOffice(Id officeId, Proxy proxy)	Gets the OsidSession associated with the step processor earch service for the given office.
StepProcessorSmartOfficeSession	getStepProcessorSmartOfficeSession(Id officeId, Proxy proxy)	Gets the OsidSession to manage step processor smart office.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface WorkflowRulesProfile

getProcessConstrainerEnablerRecordTypes, getProcessConstrainerEnablerSearchRecordTypes, getProcessConstrainerRecordTypes, getProcessConstrainerSearchRecordTypes, getProcessEnablerRecordTypes, getProcessEnablerSearchRecordTypes, getProcessProcessorEnablerRecordTypes, getProcessProcessorEnablerSearchRecordTypes, getProcessProcessorRecordTypes, getProcessProcessorSearchRecordTypes, getStepConstrainerEnablerRecordTypes, getStepConstrainerEnablerSearchRecordTypes, getStepConstrainerRecordTypes, getStepConstrainerSearchRecordTypes, getStepEnablerRecordTypes, getStepEnablerSearchRecordTypes, getStepProcessorEnablerRecordTypes, getStepProcessorEnablerSearchRecordTypes, getStepProcessorRecordTypes, getStepProcessorSearchRecordTypes, supportsProcessConstrainerAdmin, supportsProcessConstrainerEnablerAdmin, supportsProcessConstrainerEnablerLookup, supportsProcessConstrainerEnablerNotification, supportsProcessConstrainerEnablerOffice, supportsProcessConstrainerEnablerOfficeAssignment, supportsProcessConstrainerEnablerQuery, supportsProcessConstrainerEnablerRecordType, supportsProcessConstrainerEnablerRuleApplication, supportsProcessConstrainerEnablerRuleLookup, supportsProcessConstrainerEnablerSearch, supportsProcessConstrainerEnablerSearchRecordType, supportsProcessConstrainerEnablerSmartOffice, supportsProcessConstrainerLookup, supportsProcessConstrainerNotification, supportsProcessConstrainerOffice, supportsProcessConstrainerOfficeAssignment, supportsProcessConstrainerQuery, supportsProcessConstrainerRecordType, supportsProcessConstrainerRuleApplication, supportsProcessConstrainerRuleLookup, supportsProcessConstrainerSearch, supportsProcessConstrainerSearchRecordType, supportsProcessConstrainerSmartOffice, supportsProcessEnablerAdmin, supportsProcessEnablerLookup, supportsProcessEnablerNotification, supportsProcessEnablerOffice, supportsProcessEnablerOfficeAssignment, supportsProcessEnablerQuery, supportsProcessEnablerRecordType, supportsProcessEnablerRuleApplication, supportsProcessEnablerRuleLookup, supportsProcessEnablerSearch, supportsProcessEnablerSearchRecordType, supportsProcessEnablerSmartOffice, supportsProcessProcessorAdmin, supportsProcessProcessorEnablerAdmin, supportsProcessProcessorEnablerLookup, supportsProcessProcessorEnablerNotification, supportsProcessProcessorEnablerOffice, supportsProcessProcessorEnablerOfficeAssignment, supportsProcessProcessorEnablerQuery, supportsProcessProcessorEnablerRecordType, supportsProcessProcessorEnablerRuleApplication, supportsProcessProcessorEnablerRuleLookup, supportsProcessProcessorEnablerSearch, supportsProcessProcessorEnablerSearchRecordType, supportsProcessProcessorEnablerSmartOffice, supportsProcessProcessorLookup, supportsProcessProcessorNotification, supportsProcessProcessorOffice, supportsProcessProcessorOfficeAssignment, supportsProcessProcessorQuery, supportsProcessProcessorRecordType, supportsProcessProcessorRuleApplication, supportsProcessProcessorRuleLookup, supportsProcessProcessorSearch, supportsProcessProcessorSearchRecordType, supportsProcessProcessorSmartOffice, supportsStepConstrainerAdmin, supportsStepConstrainerEnablerAdmin, supportsStepConstrainerEnablerLookup, supportsStepConstrainerEnablerNotification, supportsStepConstrainerEnablerOffice, supportsStepConstrainerEnablerOfficeAssignment, supportsStepConstrainerEnablerQuery, supportsStepConstrainerEnablerRecordType, supportsStepConstrainerEnablerRuleApplication, supportsStepConstrainerEnablerRuleLookup, supportsStepConstrainerEnablerSearch, supportsStepConstrainerEnablerSearchRecordType, supportsStepConstrainerEnablerSmartOffice, supportsStepConstrainerLookup, supportsStepConstrainerNotification, supportsStepConstrainerOffice, supportsStepConstrainerOfficeAssignment, supportsStepConstrainerQuery, supportsStepConstrainerRecordType, supportsStepConstrainerRuleApplication, supportsStepConstrainerRuleLookup, supportsStepConstrainerSearch, supportsStepConstrainerSearchRecordType, supportsStepConstrainerSmartOffice, supportsStepEnablerAdmin, supportsStepEnablerLookup, supportsStepEnablerNotification, supportsStepEnablerOffice, supportsStepEnablerOfficeAssignment, supportsStepEnablerQuery, supportsStepEnablerRecordType, supportsStepEnablerRuleApplication, supportsStepEnablerRuleLookup, supportsStepEnablerSearch, supportsStepEnablerSearchRecordType, supportsStepEnablerSmartOffice, supportsStepProcessorAdmin, supportsStepProcessorEnablerAdmin, supportsStepProcessorEnablerLookup, supportsStepProcessorEnablerNotification, supportsStepProcessorEnablerOffice, supportsStepProcessorEnablerOfficeAssignment, supportsStepProcessorEnablerQuery, supportsStepProcessorEnablerRecordType, supportsStepProcessorEnablerRuleApplication, supportsStepProcessorEnablerRuleLookup, supportsStepProcessorEnablerSearch, supportsStepProcessorEnablerSearchRecordType, supportsStepProcessorEnablerSmartOffice, supportsStepProcessorLookup, supportsStepProcessorNotification, supportsStepProcessorOffice, supportsStepProcessorOfficeAssignment, supportsStepProcessorQuery, supportsStepProcessorRecordType, supportsStepProcessorRuleApplication, supportsStepProcessorRuleLookup, supportsStepProcessorSearch, supportsStepProcessorSearchRecordType, supportsStepProcessorSmartOffice, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getProcessConstrainerEnablerRecordTypes()	Gets the supported ProcessConstrainerEnabler record types.
TypeList	getProcessConstrainerEnablerSearchRecordTypes()	Gets the supported ProcessConstrainerEnabler search types.
TypeList	getProcessConstrainerRecordTypes()	Gets the supported ProcessConstrainer record types.
TypeList	getProcessConstrainerSearchRecordTypes()	Gets the supported ProcessConstrainer search types.
TypeList	getProcessEnablerRecordTypes()	Gets the supported ProcessEnabler record types.
TypeList	getProcessEnablerSearchRecordTypes()	Gets the supported ProcessEnabler search types.
TypeList	getProcessProcessorEnablerRecordTypes()	Gets the supported ProcessProcessorEnabler record types.
TypeList	getProcessProcessorEnablerSearchRecordTypes()	Gets the supported ProcessProcessorEnabler search types.
TypeList	getProcessProcessorRecordTypes()	Gets the supported ProcessProcessor record types.
TypeList	getProcessProcessorSearchRecordTypes()	Gets the supported ProcessProcessor search types.
TypeList	getStepConstrainerEnablerRecordTypes()	Gets the supported StepConstrainerEnabler record types.
TypeList	getStepConstrainerEnablerSearchRecordTypes()	Gets the supported StepConstrainerEnabler search record types.
TypeList	getStepConstrainerRecordTypes()	Gets the supported StepConstrainer record types.
TypeList	getStepConstrainerSearchRecordTypes()	Gets the supported StepConstrainer search record types.
TypeList	getStepEnablerRecordTypes()	Gets the supported StepEnabler record types.
TypeList	getStepEnablerSearchRecordTypes()	Gets the supported StepEnabler search types.
TypeList	getStepProcessorEnablerRecordTypes()	Gets the supported StepProcessorEnabler record types.
TypeList	getStepProcessorEnablerSearchRecordTypes()	Gets the supported StepProcessorEnabler search record types.
TypeList	getStepProcessorRecordTypes()	Gets the supported StepProcessor record types.
TypeList	getStepProcessorSearchRecordTypes()	Gets the supported StepProcessor search record types.
boolean	supportsProcessConstrainerAdmin()	Tests if a process constrainer administrative service is supported.
boolean	supportsProcessConstrainerEnablerAdmin()	Tests if a process constrainer enabler administrative service is supported.
boolean	supportsProcessConstrainerEnablerLookup()	Tests if looking up process constrainer enablers is supported.
boolean	supportsProcessConstrainerEnablerNotification()	Tests if a process constrainer enabler notification service is supported.
boolean	supportsProcessConstrainerEnablerOffice()	Tests if a process constrainer enabler office lookup service is supported.
boolean	supportsProcessConstrainerEnablerOfficeAssignment()	Tests if a process constrainer enabler office assignment service is supported.
boolean	supportsProcessConstrainerEnablerQuery()	Tests if querying process constrainer enablers is supported.
boolean	supportsProcessConstrainerEnablerRecordType(Type processConstrainerEnablerRecordType)	Tests if the given ProcessCosntrainerEnabler record type is supported.
boolean	supportsProcessConstrainerEnablerRuleApplication()	Tests if a process constrainer enabler rule application service is supported.
boolean	supportsProcessConstrainerEnablerRuleLookup()	Tests if a process constrainer enabler rule lookup service is supported.
boolean	supportsProcessConstrainerEnablerSearch()	Tests if searching process constrainer enablers is supported.
boolean	supportsProcessConstrainerEnablerSearchRecordType(Type processConstrainerEnablerSearchRecordType)	Tests if the given ProcessConstrainerEnabler search type is supported.
boolean	supportsProcessConstrainerEnablerSmartOffice()	Tests if a process smart office service is supported.
boolean	supportsProcessConstrainerLookup()	Tests if looking up process constrainers is supported.
boolean	supportsProcessConstrainerNotification()	Tests if a process constrainer notification service is supported.
boolean	supportsProcessConstrainerOffice()	Tests if a process constrainer office lookup service is supported.
boolean	supportsProcessConstrainerOfficeAssignment()	Tests if a process constrainer office assignment service is supported.
boolean	supportsProcessConstrainerQuery()	Tests if querying process constrainers is supported.
boolean	supportsProcessConstrainerRecordType(Type processConstrainerRecordType)	Tests if the given ProcessConstrainer record type is supported.
boolean	supportsProcessConstrainerRuleApplication()	Tests if a process constrainer rule application service is supported.
boolean	supportsProcessConstrainerRuleLookup()	Tests if a process constrainer rule lookup service is supported.
boolean	supportsProcessConstrainerSearch()	Tests if searching process constrainers is supported.
boolean	supportsProcessConstrainerSearchRecordType(Type processConstrainerSearchRecordType)	Tests if the given ProcessConstrainer search type is supported.
boolean	supportsProcessConstrainerSmartOffice()	Tests if a process smart office service is supported.
boolean	supportsProcessEnablerAdmin()	Tests if a process enabler administrative service is supported.
boolean	supportsProcessEnablerLookup()	Tests if looking up process enablers is supported.
boolean	supportsProcessEnablerNotification()	Tests if a process enabler notification service is supported.
boolean	supportsProcessEnablerOffice()	Tests if a process enabler office lookup service is supported.
boolean	supportsProcessEnablerOfficeAssignment()	Tests if a process enabler office assignment service is supported.
boolean	supportsProcessEnablerQuery()	Tests if querying process enablers is supported.
boolean	supportsProcessEnablerRecordType(Type processEnablerRecordType)	Tests if the given ProcessEnabler record type is supported.
boolean	supportsProcessEnablerRuleApplication()	Tests if a process enabler rule application service is supported.
boolean	supportsProcessEnablerRuleLookup()	Tests if a process enabler rule lookup service is supported.
boolean	supportsProcessEnablerSearch()	Tests if searching process enablers is supported.
boolean	supportsProcessEnablerSearchRecordType(Type processEnablerSearchRecordType)	Tests if the given ProcessEnabler search type is supported.
boolean	supportsProcessEnablerSmartOffice()	Tests if a process smart office service is supported.
boolean	supportsProcessProcessorAdmin()	Tests if a process processor administrative service is supported.
boolean	supportsProcessProcessorEnablerAdmin()	Tests if a process processor enabler administrative service is supported.
boolean	supportsProcessProcessorEnablerLookup()	Tests if looking up process processor enablers is supported.
boolean	supportsProcessProcessorEnablerNotification()	Tests if a process processor enabler notification service is supported.
boolean	supportsProcessProcessorEnablerOffice()	Tests if a process processor enabler office lookup service is supported.
boolean	supportsProcessProcessorEnablerOfficeAssignment()	Tests if a process processor enabler office assignment service is supported.
boolean	supportsProcessProcessorEnablerQuery()	Tests if querying process processor enablers is supported.
boolean	supportsProcessProcessorEnablerRecordType(Type processProcessorEnablerRecordType)	Tests if the given ProcessProcessorEnabler record type is supported.
boolean	supportsProcessProcessorEnablerRuleApplication()	Tests if a process processor enabler rule application service is supported.
boolean	supportsProcessProcessorEnablerRuleLookup()	Tests if a process processor enabler rule lookup service is supported.
boolean	supportsProcessProcessorEnablerSearch()	Tests if searching process processor enablers is supported.
boolean	supportsProcessProcessorEnablerSearchRecordType(Type processProcessorEnablerSearchRecordType)	Tests if the given ProcessProcessorEnabler search type is supported.
boolean	supportsProcessProcessorEnablerSmartOffice()	Tests if a process smart office service is supported.
boolean	supportsProcessProcessorLookup()	Tests if looking up process processors is supported.
boolean	supportsProcessProcessorNotification()	Tests if a process processor notification service is supported.
boolean	supportsProcessProcessorOffice()	Tests if a process processor office lookup service is supported.
boolean	supportsProcessProcessorOfficeAssignment()	Tests if a process processor office assignment service is supported.
boolean	supportsProcessProcessorQuery()	Tests if querying process processors is supported.
boolean	supportsProcessProcessorRecordType(Type processConstrainerRecordType)	Tests if the given ProcessProcessor record type is supported.
boolean	supportsProcessProcessorRuleApplication()	Tests if a process processor rule application service is supported.
boolean	supportsProcessProcessorRuleLookup()	Tests if a process processor rule lookup service is supported.
boolean	supportsProcessProcessorSearch()	Tests if searching process processors is supported.
boolean	supportsProcessProcessorSearchRecordType(Type processProcessorSearchRecordType)	Tests if the given ProcessProcessor search type is supported.
boolean	supportsProcessProcessorSmartOffice()	Tests if a process smart office service is supported.
boolean	supportsStepConstrainerAdmin()	Tests if a step constrainer administrative service is supported.
boolean	supportsStepConstrainerEnablerAdmin()	Tests if a step constrainer enabler administrative service is supported.
boolean	supportsStepConstrainerEnablerLookup()	Tests if looking up step constrainer enablers is supported.
boolean	supportsStepConstrainerEnablerNotification()	Tests if a step constrainer enabler notification service is supported.
boolean	supportsStepConstrainerEnablerOffice()	Tests if a step constrainer enabler office lookup service is supported.
boolean	supportsStepConstrainerEnablerOfficeAssignment()	Tests if a step constrainer enabler office service is supported.
boolean	supportsStepConstrainerEnablerQuery()	Tests if querying step constrainer enablers is supported.
boolean	supportsStepConstrainerEnablerRecordType(Type stepConstrainerEnablerRecordType)	Tests if the given StepConstrainerEnabler record type is supported.
boolean	supportsStepConstrainerEnablerRuleApplication()	Tests if a step constrainer enabler rule application service is supported.
boolean	supportsStepConstrainerEnablerRuleLookup()	Tests if a step constrainer enabler rule lookup service is supported.
boolean	supportsStepConstrainerEnablerSearch()	Tests if searching step constrainer enablers is supported.
boolean	supportsStepConstrainerEnablerSearchRecordType(Type stepConstrainerEnablerSearchRecordType)	Tests if the given StepConstrainerEnabler search record type is supported.
boolean	supportsStepConstrainerEnablerSmartOffice()	Tests if a step constrainer enabler office lookup service is supported.
boolean	supportsStepConstrainerLookup()	Tests if looking up step constrainer is supported.
boolean	supportsStepConstrainerNotification()	Tests if a step constrainer notification service is supported.
boolean	supportsStepConstrainerOffice()	Tests if a step constrainer office lookup service is supported.
boolean	supportsStepConstrainerOfficeAssignment()	Tests if a step constrainer office service is supported.
boolean	supportsStepConstrainerQuery()	Tests if querying step constrainer is supported.
boolean	supportsStepConstrainerRecordType(Type stepConstrainerRecordType)	Tests if the given StepConstrainer record type is supported.
boolean	supportsStepConstrainerRuleApplication()	Tests if a step constrainer rule application service is supported.
boolean	supportsStepConstrainerRuleLookup()	Tests if a step constrainer rule lookup service is supported.
boolean	supportsStepConstrainerSearch()	Tests if searching step constrainer is supported.
boolean	supportsStepConstrainerSearchRecordType(Type stepConstrainerSearchRecordType)	Tests if the given StepConstrainer search record type is supported.
boolean	supportsStepConstrainerSmartOffice()	Tests if a step constrainer office lookup service is supported.
boolean	supportsStepEnablerAdmin()	Tests if a step enabler administrative service is supported.
boolean	supportsStepEnablerLookup()	Tests if looking up step enablers is supported.
boolean	supportsStepEnablerNotification()	Tests if a step enabler notification service is supported.
boolean	supportsStepEnablerOffice()	Tests if a step enabler office lookup service is supported.
boolean	supportsStepEnablerOfficeAssignment()	Tests if a step enabler office assignment service is supported.
boolean	supportsStepEnablerQuery()	Tests if querying step enablers is supported.
boolean	supportsStepEnablerRecordType(Type stepEnablerRecordType)	Tests if the given StepEnabler record type is supported.
boolean	supportsStepEnablerRuleApplication()	Tests if a step enabler rule application service is supported.
boolean	supportsStepEnablerRuleLookup()	Tests if a step enabler rule lookup service is supported.
boolean	supportsStepEnablerSearch()	Tests if searching step enablers is supported.
boolean	supportsStepEnablerSearchRecordType(Type stepEnablerSearchRecordType)	Tests if the given StepEnabler search type is supported.
boolean	supportsStepEnablerSmartOffice()	Tests if a step smart office service is supported.
boolean	supportsStepProcessorAdmin()	Tests if a step processor administrative service is supported.
boolean	supportsStepProcessorEnablerAdmin()	Tests if a step processor enabler administrative service is supported.
boolean	supportsStepProcessorEnablerLookup()	Tests if looking up step processor enablers is supported.
boolean	supportsStepProcessorEnablerNotification()	Tests if a step processor enabler notification service is supported.
boolean	supportsStepProcessorEnablerOffice()	Tests if a step processor enabler office lookup service is supported.
boolean	supportsStepProcessorEnablerOfficeAssignment()	Tests if a step processor enabler office service is supported.
boolean	supportsStepProcessorEnablerQuery()	Tests if querying step processor enablers is supported.
boolean	supportsStepProcessorEnablerRecordType(Type stepProcessorEnablerRecordType)	Tests if the given StepProcessorEnabler record type is supported.
boolean	supportsStepProcessorEnablerRuleApplication()	Tests if a step processor enabler rule application service is supported.
boolean	supportsStepProcessorEnablerRuleLookup()	Tests if a step processor enabler rule lookup service is supported.
boolean	supportsStepProcessorEnablerSearch()	Tests if searching step processor enablers is supported.
boolean	supportsStepProcessorEnablerSearchRecordType(Type stepProcessorEnablerSearchRecordType)	Tests if the given StepProcessorEnabler search record type is supported.
boolean	supportsStepProcessorEnablerSmartOffice()	Tests if a step processor enabler office lookup service is supported.
boolean	supportsStepProcessorLookup()	Tests if looking up step processor is supported.
boolean	supportsStepProcessorNotification()	Tests if a step processor notification service is supported.
boolean	supportsStepProcessorOffice()	Tests if a step processor office lookup service is supported.
boolean	supportsStepProcessorOfficeAssignment()	Tests if a step processor office service is supported.
boolean	supportsStepProcessorQuery()	Tests if querying step processor is supported.
boolean	supportsStepProcessorRecordType(Type stepProcessorRecordType)	Tests if the given StepProcessor record type is supported.
boolean	supportsStepProcessorRuleApplication()	Tests if a step processor rule application service is supported.
boolean	supportsStepProcessorRuleLookup()	Tests if a step processor rule lookup service is supported.
boolean	supportsStepProcessorSearch()	Tests if searching step processor is supported.
boolean	supportsStepProcessorSearchRecordType(Type stepProcessorSearchRecordType)	Tests if the given StepProcessor search record type is supported.
boolean	supportsStepProcessorSmartOffice()	Tests if a step processor office lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Method Details

getProcessEnablerLookupSession

ProcessEnablerLookupSession getProcessEnablerLookupSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the process enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerLookup()} is {@code true} .

getProcessEnablerLookupSessionForOffice

ProcessEnablerLookupSession getProcessEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerQuerySession

ProcessEnablerQuerySession getProcessEnablerQuerySession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the process enabler query service.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerQuery()} is {@code true} .

getProcessEnablerQuerySessionForOffice

ProcessEnablerQuerySession getProcessEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerSearchSession

ProcessEnablerSearchSession getProcessEnablerSearchSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the process enabler search service.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerSearch()} is {@code true} .

getProcessEnablerSearchSessionForOffice

ProcessEnablerSearchSession getProcessEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerAdminSession

ProcessEnablerAdminSession getProcessEnablerAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the process enabler administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerAdmin()} is {@code true} .

getProcessEnablerAdminSessionForOffice

ProcessEnablerAdminSession getProcessEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerNotificationSession

ProcessEnablerNotificationSession getProcessEnablerNotificationSession(ProcessEnablerReceiver processEnablerReceiver,
 Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the process enabler notification service.

Parameters:

processEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessEnablerNotificationSession

Throws:

NullArgumentException - processReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerNotification()} is {@code true} .

getProcessEnablerNotificationSessionForOffice

ProcessEnablerNotificationSession getProcessEnablerNotificationSessionForOffice(ProcessEnablerReceiver processEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

processEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processEnablerReceiver,officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerOfficeSession

ProcessEnablerOfficeSession getProcessEnablerOfficeSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession to lookup process enabler/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerOffice()} is {@code true} .

getProcessEnablerOfficeAssignmentSession

ProcessEnablerOfficeAssignmentSession getProcessEnablerOfficeAssignmentSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with assigning process enablers to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerOfficeAssignment()} is {@code true} .

getProcessEnablerSmartOfficeSession

ProcessEnablerSmartOfficeSession getProcessEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process enabler smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerSmartOffice()} is {@code true} .

getProcessEnablerRuleLookupSession

ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the process enabler process mapping lookup service for looking up the rules applied to a process.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerRuleLookup()} is {@code true} .

getProcessEnablerRuleLookupSessionForOffice

ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process enabler mapping lookup service for the given office for looking up rules applied to a process.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessEnablerRuleApplicationSession

ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with the process constrainer assignment service to apply to processes.

Parameters:

proxy - a proxy

Returns:

a ProcessEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerRuleApplication()} is {@code true} .

getProcessEnablerRuleApplicationSessionForOffice

ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process enabler assignment service for the given office to apply to processes.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerLookupSession

ProcessConstrainerLookupSession getProcessConstrainerLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the process constrainer lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerLookup()} is {@code true} .

getProcessConstrainerLookupSessionForOffice

ProcessConstrainerLookupSession getProcessConstrainerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerQuerySession

ProcessConstrainerQuerySession getProcessConstrainerQuerySession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the process constrainer query service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerQuery()} is {@code true} .

getProcessConstrainerQuerySessionForOffice

ProcessConstrainerQuerySession getProcessConstrainerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerSearchSession

ProcessConstrainerSearchSession getProcessConstrainerSearchSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the process constrainer search service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerSearch()} is {@code true} .

getProcessConstrainerSearchSessionForOffice

ProcessConstrainerSearchSession getProcessConstrainerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerAdminSession

ProcessConstrainerAdminSession getProcessConstrainerAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the process constrainer administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerAdmin()} is {@code true} .

getProcessConstrainerAdminSessionForOffice

ProcessConstrainerAdminSession getProcessConstrainerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerNotificationSession

ProcessConstrainerNotificationSession getProcessConstrainerNotificationSession(ProcessConstrainerReceiver processConstrainerReceiver,
 Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the process constrainer notification service.

Parameters:

processConstrainerReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessConstrainerNotificationSession

Throws:

NullArgumentException - processConstrainerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerNotification()} is {@code true} .

getProcessConstrainerNotificationSessionForOffice

ProcessConstrainerNotificationSession getProcessConstrainerNotificationSessionForOffice(ProcessConstrainerReceiver processConstrainerReceiver,
 Id officeId,
 Proxy proxy)
                                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

processConstrainerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processConstrainerReceiver , officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerOfficeSession

ProcessConstrainerOfficeSession getProcessConstrainerOfficeSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession to lookup process constrainer/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerOffice()} is {@code true} .

getProcessConstrainerOfficeAssignmentSession

ProcessConstrainerOfficeAssignmentSession getProcessConstrainerOfficeAssignmentSession(Proxy proxy)
                                                                                throws OperationFailedException

Gets the OsidSession associated with assigning process constrainers to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerOfficeAssignment()} is {@code true} .

getProcessConstrainerSmartOfficeSession

ProcessConstrainerSmartOfficeSession getProcessConstrainerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process constrainer smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerSmartOffice()} is {@code true} .

getProcessConstrainerRuleLookupSession

ProcessConstrainerRuleLookupSession getProcessConstrainerRuleLookupSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the process constrainer process mapping lookup service for looking up the rules applied to a process.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerRuleLookup()} is {@code true} .

getProcessConstrainerRuleLookupSessionForOffice

ProcessConstrainerRuleLookupSession getProcessConstrainerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process constrainer mapping lookup service for the given office for looking up rules applied to a process

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerRuleApplicationSession

ProcessConstrainerRuleApplicationSession getProcessConstrainerRuleApplicationSession(Proxy proxy)
                                                                              throws OperationFailedException

Gets the OsidSession associated with the process constrainer assignment service to apply to processes.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerRuleApplication()} is {@code true} .

getProcessConstrainerRuleApplicationSessionForOffice

ProcessConstrainerRuleApplicationSession getProcessConstrainerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process constrainer assignment service for the given office to apply to processes.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerLookupSession

ProcessConstrainerEnablerLookupSession getProcessConstrainerEnablerLookupSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerLookup()} is {@code true} .

getProcessConstrainerEnablerLookupSessionForOffice

ProcessConstrainerEnablerLookupSession getProcessConstrainerEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerQuerySession

ProcessConstrainerEnablerQuerySession getProcessConstrainerEnablerQuerySession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler query service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerQuery()} is {@code true} .

getProcessConstrainerEnablerQuerySessionForOffice

ProcessConstrainerEnablerQuerySession getProcessConstrainerEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerSearchSession

ProcessConstrainerEnablerSearchSession getProcessConstrainerEnablerSearchSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler search service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSearch()} is {@code true} .

getProcessConstrainerEnablerSearchSessionForOffice

ProcessConstrainerEnablerSearchSession getProcessConstrainerEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerAdminSession

ProcessConstrainerEnablerAdminSession getProcessConstrainerEnablerAdminSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerAdmin()} is {@code true} .

getProcessConstrainerEnablerAdminSessionForOffice

ProcessConstrainerEnablerAdminSession getProcessConstrainerEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProcessConstrainerEnablerNotificationSession

ProcessConstrainerEnablerNotificationSession getProcessConstrainerEnablerNotificationSession(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver,
 Proxy proxy)
                                                                                      throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler notification service.

Parameters:

processConstrainerEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessConstrainerEnablerNotificationSession

Throws:

NullArgumentException - processConstrainerEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerNotification()} is {@code true} .

getProcessConstrainerEnablerNotificationSessionForOffice

ProcessConstrainerEnablerNotificationSession getProcessConstrainerEnablerNotificationSessionForOffice(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

processConstrainerEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processConstrainerEnablerReceiver, officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerOfficeSession

ProcessConstrainerEnablerOfficeSession getProcessConstrainerEnablerOfficeSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession to lookup process constrainer enabler/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerOffice()} is {@code true} .

getProcessConstrainerEnablerOfficeAssignmentSession

ProcessConstrainerEnablerOfficeAssignmentSession getProcessConstrainerEnablerOfficeAssignmentSession(Proxy proxy)
                                                                                              throws OperationFailedException

Gets the OsidSession associated with assigning process constrainer enablers to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerOfficeAssignment()} is {@code true} .

getProcessConstrainerEnablerSmartOfficeSession

ProcessConstrainerEnablerSmartOfficeSession getProcessConstrainerEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process constrainer enabler smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSmartOffice()} is {@code true} .

getProcessConstrainerEnablerRuleLookupSession

ProcessConstrainerEnablerRuleLookupSession getProcessConstrainerEnablerRuleLookupSession(Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler process mapping lookup service for looking up the rules applied to a process constrainer.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleLookup()} is {@code true} .

getProcessConstrainerEnablerRuleLookupSessionForOffice

ProcessConstrainerEnablerRuleLookupSession getProcessConstrainerEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process constrainer enabler mapping lookup service for the given office for looking up rules applied to a process constrainer.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessConstrainerEnablerRuleApplicationSession

ProcessConstrainerEnablerRuleApplicationSession getProcessConstrainerEnablerRuleApplicationSession(Proxy proxy)
                                                                                            throws OperationFailedException

Gets the OsidSession associated with the process constrainer enabler assignment service to apply to process constrainers.

Parameters:

proxy - a proxy

Returns:

a ProcessConstrainerEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleApplication()} is {@code true} .

getProcessConstrainerEnablerRuleApplicationSessionForOffice

ProcessConstrainerEnablerRuleApplicationSession getProcessConstrainerEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process constrainer enabler assignment service for the given office to apply to process constrainers.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessConstrainerEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessConstrainerEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorLookupSession

ProcessProcessorLookupSession getProcessProcessorLookupSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the process processor lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorLookup()} is {@code true} .

getProcessProcessorLookupSessionForOffice

ProcessProcessorLookupSession getProcessProcessorLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true}

getProcessProcessorQuerySession

ProcessProcessorQuerySession getProcessProcessorQuerySession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the process processor query service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorQuery()} is {@code true} .

getProcessProcessorQuerySessionForOffice

ProcessProcessorQuerySession getProcessProcessorQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorSearchSession

ProcessProcessorSearchSession getProcessProcessorSearchSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the process processor search service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorSearch()} is {@code true} .

getProcessProcessorSearchSessionForOffice

ProcessProcessorSearchSession getProcessProcessorSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true}

getProcessProcessorAdminSession

ProcessProcessorAdminSession getProcessProcessorAdminSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the process processor administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorAdmin()} is {@code true} .

getProcessProcessorAdminSessionForOffice

ProcessProcessorAdminSession getProcessProcessorAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorNotificationSession

ProcessProcessorNotificationSession getProcessProcessorNotificationSession(ProcessProcessorReceiver processProcessorReceiver,
 Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the process processor notification service.

Parameters:

processProcessorReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessProcessorNotificationSession

Throws:

NullArgumentException - processConstrainerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorNotification()} is {@code true} .

getProcessProcessorNotificationSessionForOffice

ProcessProcessorNotificationSession getProcessProcessorNotificationSessionForOffice(ProcessProcessorReceiver processProcessorReceiver,
 Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

processProcessorReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processProcessorReceiver , officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorOfficeSession

ProcessProcessorOfficeSession getProcessProcessorOfficeSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession to lookup process processor/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorOffice()} is {@code true} .

getProcessProcessorOfficeAssignmentSession

ProcessProcessorOfficeAssignmentSession getProcessProcessorOfficeAssignmentSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with assigning process processors to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorOfficeAssignment()} is {@code true} .

getProcessProcessorSmartOfficeSession

ProcessProcessorSmartOfficeSession getProcessProcessorSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process processor smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorSmartOffice()} is {@code true} .

getProcessProcessorRuleLookupSession

ProcessProcessorRuleLookupSession getProcessProcessorRuleLookupSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the process processor process mapping lookup service for looking up the rules applied to a process.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorRuleLookup()} is {@code true} .

getProcessProcessorRuleLookupSessionForOffice

ProcessProcessorRuleLookupSession getProcessProcessorRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process processor mapping lookup service for the given office for looking up rules applied to a processes.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorRuleApplicationSession

ProcessProcessorRuleApplicationSession getProcessProcessorRuleApplicationSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the process processor assignment service to apply to processes.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorRuleApplication()} is {@code true} .

getProcessProcessorRuleApplicationSessionForOffice

ProcessProcessorRuleApplicationSession getProcessProcessorRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process processor assignment service for the given office to apply to processes.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorEnablerLookupSession

ProcessProcessorEnablerLookupSession getProcessProcessorEnablerLookupSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with the process processor enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerLookup()} is {@code true} .

getProcessProcessorEnablerLookupSessionForOffice

ProcessProcessorEnablerLookupSession getProcessProcessorEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorEnablerQuerySession

ProcessProcessorEnablerQuerySession getProcessProcessorEnablerQuerySession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the process processor enabler query service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerQuery()} is {@code true} .

getProcessProcessorEnablerQuerySessionForOffice

ProcessProcessorEnablerQuerySession getProcessProcessorEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true}

getProcessProcessorEnablerSearchSession

ProcessProcessorEnablerSearchSession getProcessProcessorEnablerSearchSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with the process processor enabler search service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerSearch()} is {@code true} .

getProcessProcessorEnablerSearchSessionForOffice

ProcessProcessorEnablerSearchSession getProcessProcessorEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true}

getProcessProcessorEnablerAdminSession

ProcessProcessorEnablerAdminSession getProcessProcessorEnablerAdminSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the process processor enabler administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerAdmin()} is {@code true} .

getProcessProcessorEnablerAdminSessionForOffice

ProcessProcessorEnablerAdminSession getProcessProcessorEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProcessProcessorEnablerNotificationSession

ProcessProcessorEnablerNotificationSession getProcessProcessorEnablerNotificationSession(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver,
 Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with the process processor enabler notification service.

Parameters:

processProcessorEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ProcessProcessorEnablerNotificationSession

Throws:

NullArgumentException - processProcessorEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerNotification()} is {@code true} .

getProcessProcessorEnablerNotificationSessionForOffice

ProcessProcessorEnablerNotificationSession getProcessProcessorEnablerNotificationSessionForOffice(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

processProcessorEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processProcessorEnablerReceiver , officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorEnablerOfficeSession

ProcessProcessorEnablerOfficeSession getProcessProcessorEnablerOfficeSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession to lookup process processor enabler/office mappings.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerOffice()} is {@code true} .

getProcessProcessorEnablerOfficeAssignmentSession

ProcessProcessorEnablerOfficeAssignmentSession getProcessProcessorEnablerOfficeAssignmentSession(Proxy proxy)
                                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning process processors enablers to offices.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerOfficeAssignment()} is {@code true} .

getProcessProcessorEnablerSmartOfficeSession

ProcessProcessorEnablerSmartOfficeSession getProcessProcessorEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process processor enabler smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerSmartOffice()} is {@code true} .

getProcessProcessorEnablerRuleLookupSession

ProcessProcessorEnablerRuleLookupSession getProcessProcessorEnablerRuleLookupSession(Proxy proxy)
                                                                              throws OperationFailedException

Gets the OsidSession associated with the process processor enabler process mapping lookup service for looking up the rules applied to a process processor.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleLookup()} is {@code true} .

getProcessProcessorEnablerRuleLookupSessionForOffice

ProcessProcessorEnablerRuleLookupSession getProcessProcessorEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process processor enabler mapping lookup service for the given office for looking up rules applied to a process processors.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProcessProcessorEnablerRuleApplicationSession

ProcessProcessorEnablerRuleApplicationSession getProcessProcessorEnablerRuleApplicationSession(Proxy proxy)
                                                                                        throws OperationFailedException

Gets the OsidSession associated with the process processor enabler assignment service to apply to process processors.

Parameters:

proxy - a proxy

Returns:

a ProcessProcessorEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleApplication()} is {@code true} .

getProcessProcessorEnablerRuleApplicationSessionForOffice

ProcessProcessorEnablerRuleApplicationSession getProcessProcessorEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process processor enabler assignment service for the given office to apply to process processors.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessProcessorEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessProcessorEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessProcessorEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerLookupSession

StepEnablerLookupSession getStepEnablerLookupSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the step enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a StepEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerLookup()} is {@code true} .

getStepEnablerLookupSessionForOffice

StepEnablerLookupSession getStepEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerQuerySession

StepEnablerQuerySession getStepEnablerQuerySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the step enabler query service.

Parameters:

proxy - a proxy

Returns:

a StepEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerQuery()} is {@code true} .

getStepEnablerQuerySessionForOffice

StepEnablerQuerySession getStepEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerSearchSession

StepEnablerSearchSession getStepEnablerSearchSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the step enabler search service.

Parameters:

proxy - a proxy

Returns:

a StepEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerSearch()} is {@code true} .

getStepEnablerSearchSessionForOffice

StepEnablerSearchSession getStepEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerAdminSession

StepEnablerAdminSession getStepEnablerAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the step enabler administration service.

Parameters:

proxy - a proxy

Returns:

a StepEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerAdmin()} is {@code true} .

getStepEnablerAdminSessionForOffice

StepEnablerAdminSession getStepEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerNotificationSession

StepEnablerNotificationSession getStepEnablerNotificationSession(StepEnablerReceiver stepEnablerReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the step enabler notification service.

Parameters:

stepEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a StepEnablerNotificationSession

Throws:

NullArgumentException - stepReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerNotification()} is {@code true} .

getStepEnablerNotificationSessionForOffice

StepEnablerNotificationSession getStepEnablerNotificationSessionForOffice(StepEnablerReceiver stepEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

stepEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepEnablerReceiver,officeId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerOfficeSession

StepEnablerOfficeSession getStepEnablerOfficeSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup step enabler/office mappings.

Parameters:

proxy - a proxy

Returns:

a StepEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerOffice()} is {@code true} .

getStepEnablerOfficeAssignmentSession

StepEnablerOfficeAssignmentSession getStepEnablerOfficeAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning step enablers to offices.

Parameters:

proxy - a proxy

Returns:

a StepEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerOfficeAssignment()} is {@code true} .

getStepEnablerSmartOfficeSession

StepEnablerSmartOfficeSession getStepEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step enabler smart offices.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerSmartOffice()} is {@code true} .

getStepEnablerRuleLookupSession

StepEnablerRuleLookupSession getStepEnablerRuleLookupSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the step enabler step mapping lookup service for looking up the rules applied to a step.

Parameters:

proxy - a proxy

Returns:

a StepEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerRuleLookup()} is {@code true} .

getStepEnablerRuleLookupSessionForOffice

StepEnablerRuleLookupSession getStepEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step enabler mapping lookup service for the given office for looking up rules applied to a step.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepEnablerRuleApplicationSession

StepEnablerRuleApplicationSession getStepEnablerRuleApplicationSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the step constrainer assignment service to apply to steps.

Parameters:

proxy - a proxy

Returns:

a StepEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerRuleApplication()} is {@code true} .

getStepEnablerRuleApplicationSessionForOffice

StepEnablerRuleApplicationSession getStepEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step enabler assignment service for the given office to apply to steps.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerLookupSession

StepConstrainerLookupSession getStepConstrainerLookupSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the step constrainer lookup service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerLookup()} is {@code true} .

getStepConstrainerLookupSessionForOffice

StepConstrainerLookupSession getStepConstrainerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerQuerySession

StepConstrainerQuerySession getStepConstrainerQuerySession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the step constrainer query service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerQuery()} is {@code true} .

getStepConstrainerQuerySessionForOffice

StepConstrainerQuerySession getStepConstrainerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerQuerySession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerSearchSession

StepConstrainerSearchSession getStepConstrainerSearchSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the step constrainer search service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerSearch()} is {@code true} .

getStepConstrainerSearchSessionForOffice

StepConstrainerSearchSession getStepConstrainerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step constrainer earch service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerSearchSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerAdminSession

StepConstrainerAdminSession getStepConstrainerAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the step constrainer administration service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerAdmin()} is {@code true} .

getStepConstrainerAdminSessionForOffice

StepConstrainerAdminSession getStepConstrainerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerNotificationSession

StepConstrainerNotificationSession getStepConstrainerNotificationSession(StepConstrainerReceiver stepConstrainerReceiver,
 Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the step constrainer notification service.

Parameters:

stepConstrainerReceiver - the notification callback

proxy - a proxy

Returns:

a StepConstrainerNotificationSession

Throws:

NullArgumentException - stepConstrainerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerNotification()} is {@code true} .

getStepConstrainerNotificationSessionForOffice

StepConstrainerNotificationSession getStepConstrainerNotificationSessionForOffice(StepConstrainerReceiver stepConstrainerReceiver,
 Id officeId,
 Proxy proxy)
                                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

stepConstrainerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepConstrainerReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerOfficeSession

StepConstrainerOfficeSession getStepConstrainerOfficeSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession to lookup step constrainer/office mappings for step constrainers.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerOffice()} is {@code true} .

getStepConstrainerOfficeAssignmentSession

StepConstrainerOfficeAssignmentSession getStepConstrainerOfficeAssignmentSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning step constrainer to office.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerOfficeAssignment()} is {@code true} .

getStepConstrainerSmartOfficeSession

StepConstrainerSmartOfficeSession getStepConstrainerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step constrainer smart office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerSmartOfficeSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerSmartOffice()} is {@code true} .

getStepConstrainerRuleLookupSession

StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the step constrainer mapping lookup service for looking up the rules applied to ta step.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerRuleLookup()} is {@code true} .

getStepConstrainerRuleLookupSessionForOffice

StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step constrainer mapping lookup service for the given office for looking up rules applied to a qeue.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerRuleApplicationSession

StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the step constrainer assignment service to apply to steps.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerRuleApplication()} is {@code true} .

getStepConstrainerRuleApplicationSessionForOffice

StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step constrainer assignment service for the given office to apply to steps.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerLookupSession

StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerLookup()} is {@code true} .

getStepConstrainerEnablerLookupSessionForOffice

StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerQuerySession

StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler query service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerQuery()} is {@code true} .

getStepConstrainerEnablerQuerySessionForOffice

StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerQuerySession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerSearchSession

StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler search service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerSearch()} is {@code true} .

getStepConstrainerEnablerSearchSessionForOffice

StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step constrainer enablers earch service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerSearchSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerAdminSession

StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler administration service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerAdmin()} is {@code true} .

getStepConstrainerEnablerAdminSessionForOffice

StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerNotificationSession

StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSession(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver,
 Proxy proxy)
                                                                                throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler notification service.

Parameters:

stepConstrainerEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a StepConstrainerEnablerNotificationSession

Throws:

NullArgumentException - stepConstrainerEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerNotification()} is {@code true} .

getStepConstrainerEnablerNotificationSessionForOffice

StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSessionForOffice(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

stepConstrainerEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepConstrainerEnablerReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerOfficeSession

StepConstrainerEnablerOfficeSession getStepConstrainerEnablerOfficeSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession to lookup step constrainer enabler/office mappings for step constrainer enablers.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerOffice()} is {@code true} .

getStepConstrainerEnablerOfficeAssignmentSession

StepConstrainerEnablerOfficeAssignmentSession getStepConstrainerEnablerOfficeAssignmentSession(Proxy proxy)
                                                                                        throws OperationFailedException

Gets the OsidSession associated with assigning step constrainer enablers to office.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerOfficeAssignment()} is {@code true} .

getStepConstrainerEnablerSmartOfficeSession

StepConstrainerEnablerSmartOfficeSession getStepConstrainerEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step constrainer enabler smart office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerSmartOfficeSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerSmartOffice()} is {@code true} .

getStepConstrainerEnablerRuleLookupSession

StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler mapping lookup service .

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleLookup()} is {@code true} .

getStepConstrainerEnablerRuleLookupSessionForOffice

StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepConstrainerEnablerRuleApplicationSession

StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSession(Proxy proxy)
                                                                                      throws OperationFailedException

Gets the OsidSession associated with the step constrainer enabler assignment service.

Parameters:

proxy - a proxy

Returns:

a StepConstrainerEnablerRuleApplicationSession

Throws:

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleApplication()} is {@code true} .

getStepConstrainerEnablerRuleApplicationSessionForOffice

StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step constrainer enabler assignment service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepConstrainerEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorLookupSession

StepProcessorLookupSession getStepProcessorLookupSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the step processor lookup service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorLookup()} is {@code true} .

getStepProcessorLookupSessionForOffice

StepProcessorLookupSession getStepProcessorLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorQuerySession

StepProcessorQuerySession getStepProcessorQuerySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the step processor query service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorQuery()} is {@code true} .

getStepProcessorQuerySessionForOffice

StepProcessorQuerySession getStepProcessorQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorQuerySession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorSearchSession

StepProcessorSearchSession getStepProcessorSearchSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the step processor search service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorSearch()} is {@code true} .

getStepProcessorSearchSessionForOffice

StepProcessorSearchSession getStepProcessorSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step processor earch service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorSearchSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorAdminSession

StepProcessorAdminSession getStepProcessorAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the step processor administration service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorAdmin()} is {@code true} .

getStepProcessorAdminSessionForOffice

StepProcessorAdminSession getStepProcessorAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorNotificationSession

StepProcessorNotificationSession getStepProcessorNotificationSession(StepProcessorReceiver stepProcessorReceiver,
 Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the step processor notification service.

Parameters:

stepProcessorReceiver - the notification callback

proxy - a proxy

Returns:

a StepProcessorNotificationSession

Throws:

NullArgumentException - stepProcessorReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorNotification()} is {@code true} .

getStepProcessorNotificationSessionForOffice

StepProcessorNotificationSession getStepProcessorNotificationSessionForOffice(StepProcessorReceiver stepProcessorReceiver,
 Id officeId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

stepProcessorReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepProcessorReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorOfficeSession

StepProcessorOfficeSession getStepProcessorOfficeSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession to lookup step processor/office mappings for step processors.

Parameters:

proxy - a proxy

Returns:

a StepProcessorOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorOffice()} is {@code true} .

getStepProcessorOfficeAssignmentSession

StepProcessorOfficeAssignmentSession getStepProcessorOfficeAssignmentSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning step processor to office.

Parameters:

proxy - a proxy

Returns:

a StepProcessorOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorOfficeAssignment()} is {@code true} .

getStepProcessorSmartOfficeSession

StepProcessorSmartOfficeSession getStepProcessorSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step processor smart office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorSmartOfficeSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorSmartOffice()} is {@code true} .

getStepProcessorRuleLookupSession

StepProcessorRuleLookupSession getStepProcessorRuleLookupSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the step processor mapping lookup service for looking up the rules applied to a step processor.

Parameters:

proxy - a proxy

Returns:

a StepProcessorRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorRuleLookup()} is {@code true} .

getStepProcessorRuleLookupSessionForOffice

StepProcessorRuleLookupSession getStepProcessorRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step processor mapping lookup service for the given office for looking up rules applied to a step.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorRuleApplicationSession

StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the step processor assignment service to apply to steps.

Parameters:

proxy - a proxy

Returns:

a StepProcessorRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorRuleApplication()} is {@code true} .

getStepProcessorRuleApplicationSessionForOffice

StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step processor assignment service for the given office to apply to steps.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerLookupSession

StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the step processor enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerLookup()} is {@code true} .

getStepProcessorEnablerLookupSessionForOffice

StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerQuerySession

StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the step processor enabler query service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerQuery()} is {@code true} .

getStepProcessorEnablerQuerySessionForOffice

StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySessionForOffice(Id officeId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerQuerySession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerSearchSession

StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the step processor enabler search service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerSearch()} is {@code true} .

getStepProcessorEnablerSearchSessionForOffice

StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSessionForOffice(Id officeId,
 Proxy proxy)
                                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step processor enablers earch service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerSearchSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerAdminSession

StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the step processor enabler administration service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerAdmin()} is {@code true} .

getStepProcessorEnablerAdminSessionForOffice

StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSessionForOffice(Id officeId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerNotificationSession

StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSession(StepProcessorEnablerReceiver stepProcessorEnablerReceiver,
 Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with the step processor enabler notification service.

Parameters:

stepProcessorEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a StepProcessorEnablerNotificationSession

Throws:

NullArgumentException - stepProcessorEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerNotification()} is {@code true} .

getStepProcessorEnablerNotificationSessionForOffice

StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSessionForOffice(StepProcessorEnablerReceiver stepProcessorEnablerReceiver,
 Id officeId,
 Proxy proxy)
                                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

stepProcessorEnablerReceiver - the notification callback

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepProcessorEnablerReceiver, officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerOfficeSession

StepProcessorEnablerOfficeSession getStepProcessorEnablerOfficeSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession to lookup step processor enabler/office mappings for step processor enablers.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerOfficeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerOffice()} is {@code true} .

getStepProcessorEnablerOfficeAssignmentSession

StepProcessorEnablerOfficeAssignmentSession getStepProcessorEnablerOfficeAssignmentSession(Proxy proxy)
                                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning step processor enablers to step processors.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerOfficeAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerOfficeAssignment()} is {@code true} .

getStepProcessorEnablerSmartOfficeSession

StepProcessorEnablerSmartOfficeSession getStepProcessorEnablerSmartOfficeSession(Id officeId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step processor enabler smart office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerSmartOfficeSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerSmartOffice()} is {@code true} .

getStepProcessorEnablerRuleLookupSession

StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the step processor enabler mapping lookup service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleLookup()} is {@code true} .

getStepProcessorEnablerRuleLookupSessionForOffice

StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerRuleLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getStepProcessorEnablerRuleApplicationSession

StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSession(Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with the step processor enabler assignment service.

Parameters:

proxy - a proxy

Returns:

a StepProcessorEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleApplication()} is {@code true} .

getStepProcessorEnablerRuleApplicationSessionForOffice

StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSessionForOffice(Id officeId,
 Proxy proxy)
                                                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step processor enabler assignment service for the given office.

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepProcessorEnablerRuleApplicationSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepProcessorEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .