OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.WorkflowRulesProxyManager
Implementsosid.OsidProxyManager
osid.workflow.rules.WorkflowRulesProfile
Description

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:

  • 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
  • ProcessEnablerLookupSession: a session to retrieve process enabler
  • ProcessEnablerQuerySession: a session to query for process enabler
  • ProcessEnablerSearchSession: a session to search for process enabler
  • ProcessEnablerAdminSession: a session to create and delete process enabler
  • 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 office of process enabler
  • ProcessEnablerRuleLookupSession: a session to look up process enabler to process mappings
  • ProcessEnablerRuleApplicationSession: a session to apply process enabler to processss
MethodgetStepConstrainerLookupSession
Description

Gets the OsidSession associated with the step constrainer lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerLookupSessiona StepConstrainerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerLookup() is true.
MethodgetStepConstrainerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerLookupSessiona StepConstrainerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerLookup() and supportsVisibleFederation() are true.
MethodgetStepConstrainerQuerySession
Description

Gets the OsidSession associated with the step constrainer query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerQuerySessiona StepConstrainerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerQuery() is true.
MethodgetStepConstrainerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerQuerySessiona StepConstrainerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerQuery() and supportsVisibleFederation() are true.
MethodgetStepConstrainerSearchSession
Description

Gets the OsidSession associated with the step constrainer search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerSearchSessiona StepConstrainerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerSearch() is true.
MethodgetStepConstrainerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerSearchSessiona StepConstrainerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerSearch() and supportsVisibleFederation() are true.
MethodgetStepConstrainerAdminSession
Description

Gets the OsidSession associated with the step constrainer administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerAdminSessiona StepConstrainerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerAdmin() is true.
MethodgetStepConstrainerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerAdminSessiona StepConstrainerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerAdmin() and supportsVisibleFederation() are true.
MethodgetStepConstrainerNotificationSession
Description

Gets the OsidSession associated with the step constrainer notification service.

Parametersosid.workflow.rules.StepConstrainerReceiverstepConstrainerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerNotificationSessiona StepConstrainerNotificationSession
ErrorsNULL_ARGUMENT stepConstrainerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerNotification() is true.
MethodgetStepConstrainerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.StepConstrainerReceiverstepConstrainerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerNotificationSessiona StepConstrainerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT stepConstrainerReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerNotification() and supportsVisibleFederation() are true.
MethodgetStepConstrainerOfficeSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerOfficeSessiona StepConstrainerOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerOffice() is true.
MethodgetStepConstrainerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning step constrainer to office.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerOfficeAssignmentSessiona StepConstrainerOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerOfficeAssignment() is true.
MethodgetStepConstrainerSmartOfficeSession
Description

Gets the OsidSession to manage step constrainer smart office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerSmartOfficeSessiona StepConstrainerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerSmartOffice() is true.
MethodgetStepConstrainerRuleLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerRuleLookupSessiona StepConstrainerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerRuleLookup() is true.
MethodgetStepConstrainerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerRuleLookupSessiona StepConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerRuleLookup() and supportsVisibleFederation() are true.
MethodgetStepConstrainerRuleApplicationSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerRuleApplicationSessiona StepConstrainerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerRuleApplication() is true.
MethodgetStepConstrainerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerRuleApplicationSessiona StepConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerRuleApplication() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerLookupSessiona StepConstrainerEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerLookup() is true.
MethodgetStepConstrainerEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerLookupSessiona StepConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerLookup() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerQuerySession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerQuerySessiona StepConstrainerEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerQuery() is true.
MethodgetStepConstrainerEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerQuerySessiona StepConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerQuery() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerSearchSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerSearchSessiona StepConstrainerEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerSearch() is true.
MethodgetStepConstrainerEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerSearchSessiona StepConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerSearch() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerAdminSessiona StepConstrainerEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerAdmin() is true.
MethodgetStepConstrainerEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerAdminSessiona StepConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerNotificationSession
Description

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

Parametersosid.workflow.rules.StepConstrainerEnablerReceiverstepConstrainerEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerNotificationSessiona StepConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT stepConstrainerEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerNotification() is true.
MethodgetStepConstrainerEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.StepConstrainerEnablerReceiverstepConstrainerEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerNotificationSessiona StepConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT stepConstrainerEnablerReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerNotification() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerOfficeSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerOfficeSessiona StepConstrainerEnablerOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerOffice() is true.
MethodgetStepConstrainerEnablerOfficeAssignmentSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerOfficeAssignmentSessiona StepConstrainerEnablerOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerOfficeAssignment() is true.
MethodgetStepConstrainerEnablerSmartOfficeSession
Description

Gets the OsidSession to manage step constrainer enabler smart office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerSmartOfficeSessiona StepConstrainerEnablerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerSmartOffice() is true.
MethodgetStepConstrainerEnablerRuleLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerRuleLookupSessiona StepConstrainerEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerRuleLookup() is true.
MethodgetStepConstrainerEnablerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerRuleLookupSessiona StepConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetStepConstrainerEnablerRuleApplicationSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerRuleApplicationSessiona StepConstrainerEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerRuleApplication() is true.
MethodgetStepConstrainerEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepConstrainerEnablerRuleApplicationSessiona StepConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetStepProcessorLookupSession
Description

Gets the OsidSession associated with the step processor lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorLookupSessiona StepProcessorLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorLookup() is true.
MethodgetStepProcessorLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorLookupSessiona StepProcessorLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorLookup() and supportsVisibleFederation() are true.
MethodgetStepProcessorQuerySession
Description

Gets the OsidSession associated with the step processor query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorQuerySessiona StepProcessorQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorQuery() is true.
MethodgetStepProcessorQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorQuerySessiona StepProcessorQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorQuery() and supportsVisibleFederation() are true.
MethodgetStepProcessorSearchSession
Description

Gets the OsidSession associated with the step processor search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorSearchSessiona StepProcessorSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorSearch() is true.
MethodgetStepProcessorSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorSearchSessiona StepProcessorSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorSearch() and supportsVisibleFederation() are true.
MethodgetStepProcessorAdminSession
Description

Gets the OsidSession associated with the step processor administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorAdminSessiona StepProcessorAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorAdmin() is true.
MethodgetStepProcessorAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorAdminSessiona StepProcessorAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorAdmin() and supportsVisibleFederation() are true.
MethodgetStepProcessorNotificationSession
Description

Gets the OsidSession associated with the step processor notification service.

Parametersosid.workflow.rules.StepProcessorReceiverstepProcessorReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorNotificationSessiona StepProcessorNotificationSession
ErrorsNULL_ARGUMENT stepProcessorReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorNotification() is true.
MethodgetStepProcessorNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.StepProcessorReceiverstepProcessorReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorNotificationSessiona StepProcessorNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT stepProcessorReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorNotification() and supportsVisibleFederation() are true.
MethodgetStepProcessorOfficeSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorOfficeSessiona StepProcessorOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorOffice() is true.
MethodgetStepProcessorOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning step processor to office.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorOfficeAssignmentSessiona StepProcessorOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorOfficeAssignment() is true.
MethodgetStepProcessorSmartOfficeSession
Description

Gets the OsidSession to manage step processor smart office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorSmartOfficeSessiona StepProcessorSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorSmartOffice() is true.
MethodgetStepProcessorRuleLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorRuleLookupSessiona StepProcessorRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorRuleLookup() is true.
MethodgetStepProcessorRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorRuleLookupSessiona StepProcessorRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorRuleLookup() and supportsVisibleFederation() are true.
MethodgetStepProcessorRuleApplicationSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorRuleApplicationSessiona StepProcessorRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorRuleApplication() is true.
MethodgetStepProcessorRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorRuleApplicationSessiona StepProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorRuleApplication() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerLookupSessiona StepProcessorEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerLookup() is true.
MethodgetStepProcessorEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerLookupSessiona StepProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerLookup() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerQuerySession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerQuerySessiona StepProcessorEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerQuery() is true.
MethodgetStepProcessorEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerQuerySessiona StepProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerQuery() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerSearchSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerSearchSessiona StepProcessorEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerSearch() is true.
MethodgetStepProcessorEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerSearchSessiona StepProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerSearch() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerAdminSessiona StepProcessorEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerAdmin() is true.
MethodgetStepProcessorEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerAdminSessiona StepProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerNotificationSession
Description

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

Parametersosid.workflow.rules.StepProcessorEnablerReceiverstepProcessorEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerNotificationSessiona StepProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT stepProcessorEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerNotification() is true.
MethodgetStepProcessorEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.StepProcessorEnablerReceiverstepProcessorEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerNotificationSessiona StepProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT stepProcessorEnablerReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerNotification() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerOfficeSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerOfficeSessiona StepProcessorEnablerOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerOffice() is true.
MethodgetStepProcessorEnablerOfficeAssignmentSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerOfficeAssignmentSessiona StepProcessorEnablerOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerOfficeAssignment() is true.
MethodgetStepProcessorEnablerSmartOfficeSession
Description

Gets the OsidSession to manage step processor enabler smart office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerSmartOfficeSessiona StepProcessorEnablerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerSmartOffice() is true.
MethodgetStepProcessorEnablerRuleLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerRuleLookupSessiona StepProcessorEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerRuleLookup() is true.
MethodgetStepProcessorEnablerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerRuleLookupSessiona StepProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetStepProcessorEnablerRuleApplicationSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerRuleApplicationSessiona StepProcessorEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerRuleApplication() is true.
MethodgetStepProcessorEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.StepProcessorEnablerRuleApplicationSessiona StepProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetProcessEnablerLookupSession
Description

Gets the OsidSession associated with the process enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerLookupSessiona ProcessEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerLookup() is true.
MethodgetProcessEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerLookupSessiona ProcessEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerLookup() and supportsVisibleFederation() are true.
MethodgetProcessEnablerQuerySession
Description

Gets the OsidSession associated with the process enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerQuerySessiona ProcessEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerQuery() is true.
MethodgetProcessEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerQuerySessiona ProcessEnablerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerQuery() and supportsVisibleFederation() are true.
MethodgetProcessEnablerSearchSession
Description

Gets the OsidSession associated with the process enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerSearchSessiona ProcessEnablerSearchSession
ErrorsNULL_ARGUMENTa ProcessEnablerSearchSession
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerSearch() is true.
MethodgetProcessEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerSearchSessiona ProcessEnablerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerSearch() and supportsVisibleFederation() are true.
MethodgetProcessEnablerAdminSession
Description

Gets the OsidSession associated with the process enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerAdminSessiona ProcessEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerAdmin() is true.
MethodgetProcessEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerAdminSessiona ProcessEnablerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetProcessEnablerNotificationSession
Description

Gets the OsidSession associated with the process enabler notification service.

Parametersosid.workflow.rules.ProcessEnablerReceiverprocessEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerNotificationSessiona ProcessEnablerNotificationSession
ErrorsNULL_ARGUMENT processEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerNotification() is true.
MethodgetProcessEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.ProcessEnablerReceiverprocessEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerNotificationSessiona ProcessEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENT processEnablerReceiver, officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerNotification() and supportsVisibleFederation() are true.
MethodgetProcessEnablerOfficeSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerOfficeSessiona ProcessEnablerOfficeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerOffice() is true.
MethodgetProcessEnablerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning process enabler to office.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerOfficeAssignmentSessiona ProcessEnablerOfficeAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerOfficeAssignment() is true.
MethodgetProcessEnablerSmartOfficeSession
Description

Gets the OsidSession to manage process enabler smart office.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerSmartOfficeSessiona ProcessEnablerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerSmartOffice() is true.
MethodgetProcessEnablerRuleLookupSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerRuleLookupSessiona ProcessEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleLookup() is true.
MethodgetProcessEnablerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerRuleLookupSessiona ProcessEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetProcessEnablerRuleApplicationSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerRuleApplicationSessiona ProcessEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleApplication() is true.
MethodgetProcessEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.rules.ProcessEnablerRuleApplicationSessiona ProcessEnablerRuleApplicationSession
ErrorsNOT_FOUND officeId or proxy is null
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleApplication() and supportsVisibleFederation() are true.