OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Interfaceosid.workflow.rules.WorkflowRulesManager
Implementsosid.OsidManager
osid.workflow.rules.WorkflowRulesProfile
Used Byosid.workflow.WorkflowManager
Description

The workflow rules manager provides access to workflow rules sessions and provides interoperability tests for various aspects of this service. 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 steps
  • 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 steps
  • 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 processs
MethodgetProcessEnablerLookupSession
Description

Gets the OsidSession associated with the process enabler lookup service.

Returnosid.workflow.rules.ProcessEnablerLookupSessiona ProcessEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerLookup() 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
Returnosid.workflow.rules.ProcessEnablerLookupSessiona ProcessEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerLookup() 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.

Returnosid.workflow.rules.ProcessEnablerQuerySessiona ProcessEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerQuery() 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
Returnosid.workflow.rules.ProcessEnablerQuerySessiona ProcessEnablerQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerQuery() 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.

Returnosid.workflow.rules.ProcessEnablerSearchSessiona ProcessEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerSearch() is true .
MethodgetProcessEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessEnablerSearchSessiona ProcessEnablerSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerSearch() 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.

Returnosid.workflow.rules.ProcessEnablerAdminSessiona ProcessEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerAdmin() 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
Returnosid.workflow.rules.ProcessEnablerAdminSessiona ProcessEnablerAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerAdmin() 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
Returnosid.workflow.rules.ProcessEnablerNotificationSessiona ProcessEnablerNotificationSession
ErrorsNULL_ARGUMENTprocessReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerNotification() 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
Returnosid.workflow.rules.ProcessEnablerNotificationSessiona ProcessEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTprocessEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerNotification() 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.

Returnosid.workflow.rules.ProcessEnablerOfficeSessiona ProcessEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerOffice() is true .
MethodgetProcessEnablerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning process enablers to offices.

Returnosid.workflow.rules.ProcessEnablerOfficeAssignmentSessiona ProcessEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerOfficeAssignment() is true .
MethodgetProcessEnablerSmartOfficeSession
Description

Gets the OsidSession to manage process enabler smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessEnablerSmartOfficeSessiona ProcessEnablerSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerSmartOffice() is true .
MethodgetProcessEnablerRuleLookupSession
Description

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

Returnosid.workflow.rules.ProcessEnablerRuleLookupSessiona ProcessEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerRuleLookup() 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
Returnosid.workflow.rules.ProcessEnablerRuleLookupSessiona ProcessEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProcessEnablerRuleApplicationSession
Description

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

Returnosid.workflow.rules.ProcessEnablerRuleApplicationSessiona ProcessEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerRuleApplication() 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 processes.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessEnablerRuleApplicationSessiona ProcessEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerLookupSession
Description

Gets the OsidSession associated with the process constrainer lookup service.

Returnosid.workflow.rules.ProcessConstrainerLookupSessiona ProcessConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerLookup() is true .
MethodgetProcessConstrainerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerLookupSessiona ProcessConstrainerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerLookup() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerQuerySession
Description

Gets the OsidSession associated with the process constrainer query service.

Returnosid.workflow.rules.ProcessConstrainerQuerySessiona ProcessConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerQuery() is true .
MethodgetProcessConstrainerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerQuerySessiona ProcessConstrainerQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerQuery() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerSearchSession
Description

Gets the OsidSession associated with the process constrainer search service.

Returnosid.workflow.rules.ProcessConstrainerSearchSessiona ProcessConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerSearch() is true .
MethodgetProcessConstrainerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerSearchSessiona ProcessConstrainerSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerSearch() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerAdminSession
Description

Gets the OsidSession associated with the process constrainer administration service.

Returnosid.workflow.rules.ProcessConstrainerAdminSessiona ProcessConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerAdmin() is true .
MethodgetProcessConstrainerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerAdminSessiona ProcessConstrainerAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerAdmin() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerNotificationSession
Description

Gets the OsidSession associated with the process constrainer notification service.

Parametersosid.workflow.rules.ProcessConstrainerReceiverprocessConstrainerReceiverthe notification callback
Returnosid.workflow.rules.ProcessConstrainerNotificationSessiona ProcessConstrainerNotificationSession
ErrorsNULL_ARGUMENTprocessConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerNotification() is true .
MethodgetProcessConstrainerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.ProcessConstrainerReceiverprocessConstrainerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerNotificationSessiona ProcessConstrainerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTprocessConstrainerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerNotification() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerOfficeSession
Description

Gets the OsidSession to lookup process constrainer/office mappings.

Returnosid.workflow.rules.ProcessConstrainerOfficeSessiona ProcessConstrainerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerOffice() is true .
MethodgetProcessConstrainerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning process constrainers to offices.

Returnosid.workflow.rules.ProcessConstrainerOfficeAssignmentSessiona ProcessConstrainerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerOfficeAssignment() is true .
MethodgetProcessConstrainerSmartOfficeSession
Description

Gets the OsidSession to manage process constrainer smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerSmartOfficeSessiona ProcessConstrainerSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerSmartOffice() is true .
MethodgetProcessConstrainerRuleLookupSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerRuleLookupSessiona ProcessConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerRuleLookup() is true .
MethodgetProcessConstrainerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerRuleLookupSessiona ProcessConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerRuleApplicationSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerRuleApplicationSessiona ProcessConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerRuleApplication() is true .
MethodgetProcessConstrainerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerRuleApplicationSessiona ProcessConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerRuleApplication() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerLookupSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerLookupSessiona ProcessConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerLookup() is true .
MethodgetProcessConstrainerEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerLookupSessiona ProcessConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerLookup() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerQuerySession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerQuerySessiona ProcessConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerQuery() is true .
MethodgetProcessConstrainerEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerQuerySessiona ProcessConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerQuery() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerSearchSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerSearchSessiona ProcessConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerSearch() is true .
MethodgetProcessConstrainerEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerSearchSessiona ProcessConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerSearch() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerAdminSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerAdminSessiona ProcessConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerAdmin() is true .
MethodgetProcessConstrainerEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerAdminSessiona ProcessConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerAdmin() and supportsVisibleFederation() are true
MethodgetProcessConstrainerEnablerNotificationSession
Description

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

Parametersosid.workflow.rules.ProcessConstrainerEnablerReceiverprocessConstrainerEnablerReceiverthe notification callback
Returnosid.workflow.rules.ProcessConstrainerEnablerNotificationSessiona ProcessConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENTprocessConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerNotification() is true .
MethodgetProcessConstrainerEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.ProcessConstrainerEnablerReceiverprocessConstrainerEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerNotificationSessiona ProcessConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTprocessConstrainerEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerNotification() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerOfficeSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerOfficeSessiona ProcessConstrainerEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerOffice() is true .
MethodgetProcessConstrainerEnablerOfficeAssignmentSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerOfficeAssignmentSessiona ProcessConstrainerEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerOfficeAssignment() is true .
MethodgetProcessConstrainerEnablerSmartOfficeSession
Description

Gets the OsidSession to manage process constrainer enabler smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerSmartOfficeSessiona ProcessConstrainerEnablerSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerSmartOffice() is true .
MethodgetProcessConstrainerEnablerRuleLookupSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerRuleLookupSessiona ProcessConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerRuleLookup() is true .
MethodgetProcessConstrainerEnablerRuleLookupSessionForOffice
Description

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.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerRuleLookupSessiona ProcessConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProcessConstrainerEnablerRuleApplicationSession
Description

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

Returnosid.workflow.rules.ProcessConstrainerEnablerRuleApplicationSessiona ProcessConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnablerRuleApplication() is true .
MethodgetProcessConstrainerEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessConstrainerEnablerRuleApplicationSessiona ProcessConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessConstrainerEnabelrRuleApplication() and supportsVisibleFederation() are true .
MethodgetProcessProcessorLookupSession
Description

Gets the OsidSession associated with the process processor lookup service.

Returnosid.workflow.rules.ProcessProcessorLookupSessiona ProcessProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorLookup() is true .
MethodgetProcessProcessorLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorLookupSessiona ProcessProcessorLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorLookup() and supportsVisibleFederation() are true
MethodgetProcessProcessorQuerySession
Description

Gets the OsidSession associated with the process processor query service.

Returnosid.workflow.rules.ProcessProcessorQuerySessiona ProcessProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorQuery() is true .
MethodgetProcessProcessorQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorQuerySessiona ProcessProcessorQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorQuery() and supportsVisibleFederation() are true .
MethodgetProcessProcessorSearchSession
Description

Gets the OsidSession associated with the process processor search service.

Returnosid.workflow.rules.ProcessProcessorSearchSessiona ProcessProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorSearch() is true .
MethodgetProcessProcessorSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorSearchSessiona ProcessProcessorSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorSearch() and supportsVisibleFederation() are true
MethodgetProcessProcessorAdminSession
Description

Gets the OsidSession associated with the process processor administration service.

Returnosid.workflow.rules.ProcessProcessorAdminSessiona ProcessProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorAdmin() is true .
MethodgetProcessProcessorAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorAdminSessiona ProcessProcessorAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorAdmin() and supportsVisibleFederation() are true .
MethodgetProcessProcessorNotificationSession
Description

Gets the OsidSession associated with the process processor notification service.

Parametersosid.workflow.rules.ProcessProcessorReceiverprocessProcessorReceiverthe notification callback
Returnosid.workflow.rules.ProcessProcessorNotificationSessiona ProcessProcessorNotificationSession
ErrorsNULL_ARGUMENTprocessConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorNotification() is true .
MethodgetProcessProcessorNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.ProcessProcessorReceiverprocessProcessorReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorNotificationSessiona ProcessProcessorNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTprocessProcessorReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorNotification() and supportsVisibleFederation() are true .
MethodgetProcessProcessorOfficeSession
Description

Gets the OsidSession to lookup process processor/office mappings.

Returnosid.workflow.rules.ProcessProcessorOfficeSessiona ProcessProcessorOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorOffice() is true .
MethodgetProcessProcessorOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning process processors to offices.

Returnosid.workflow.rules.ProcessProcessorOfficeAssignmentSessiona ProcessProcessorOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorOfficeAssignment() is true .
MethodgetProcessProcessorSmartOfficeSession
Description

Gets the OsidSession to manage process processor smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorSmartOfficeSessiona ProcessProcessorSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorSmartOffice() is true .
MethodgetProcessProcessorRuleLookupSession
Description

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

Returnosid.workflow.rules.ProcessProcessorRuleLookupSessiona ProcessProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorRuleLookup() is true .
MethodgetProcessProcessorRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorRuleLookupSessiona ProcessProcessorRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorRuleLookup() and supportsVisibleFederation() are true .
MethodgetProcessProcessorRuleApplicationSession
Description

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

Returnosid.workflow.rules.ProcessProcessorRuleApplicationSessiona ProcessProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorRuleApplication() is true .
MethodgetProcessProcessorRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorRuleApplicationSessiona ProcessProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorRuleApplication() and supportsVisibleFederation() are true .
MethodgetProcessProcessorEnablerLookupSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerLookupSessiona ProcessProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerLookup() is true .
MethodgetProcessProcessorEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerLookupSessiona ProcessProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerLookup() and supportsVisibleFederation() are true .
MethodgetProcessProcessorEnablerQuerySession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerQuerySessiona ProcessProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerQuery() is true .
MethodgetProcessProcessorEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerQuerySessiona ProcessProcessorEnablerQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerQuery() and supportsVisibleFederation() are true
MethodgetProcessProcessorEnablerSearchSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerSearchSessiona ProcessProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerSearch() is true .
MethodgetProcessProcessorEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerSearchSessiona ProcessProcessorEnablerSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerSearch() and supportsVisibleFederation() are true
MethodgetProcessProcessorEnablerAdminSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerAdminSessiona ProcessProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerAdmin() is true .
MethodgetProcessProcessorEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerAdminSessiona ProcessProcessorEnablerAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerAdmin() and supportsVisibleFederation() are true
MethodgetProcessProcessorEnablerNotificationSession
Description

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

Parametersosid.workflow.rules.ProcessProcessorEnablerReceiverprocessProcessorEnablerReceiverthe notification callback
Returnosid.workflow.rules.ProcessProcessorEnablerNotificationSessiona ProcessProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENTprocessProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerNotification() is true .
MethodgetProcessProcessorEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.ProcessProcessorEnablerReceiverprocessProcessorEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerNotificationSessiona ProcessProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTprocessProcessorEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerNotification() and supportsVisibleFederation() are true .
MethodgetProcessProcessorEnablerOfficeSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerOfficeSessiona ProcessProcessorEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerOffice() is true .
MethodgetProcessProcessorEnablerOfficeAssignmentSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerOfficeAssignmentSessiona ProcessProcessorEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerOfficeAssignment() is true .
MethodgetProcessProcessorEnablerSmartOfficeSession
Description

Gets the OsidSession to manage process processor enabler smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerSmartOfficeSessiona ProcessProcessorEnablerSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerSmartOffice() is true .
MethodgetProcessProcessorEnablerRuleLookupSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerRuleLookupSessiona ProcessProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerRuleLookup() is true .
MethodgetProcessProcessorEnablerRuleLookupSessionForOffice
Description

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.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerRuleLookupSessiona ProcessProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProcessProcessorEnablerRuleApplicationSession
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerRuleApplicationSessiona ProcessProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnablerRuleApplication() is true .
MethodgetProcessProcessorEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.ProcessProcessorEnablerRuleApplicationSessiona ProcessProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcessProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessProcessorEnabelrRuleApplication() and supportsVisibleFederation() are true .
MethodgetStepEnablerLookupSession
Description

Gets the OsidSession associated with the step enabler lookup service.

Returnosid.workflow.rules.StepEnablerLookupSessiona StepEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerLookup() is true .
MethodgetStepEnablerLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerLookupSessiona StepEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerLookup() and supportsVisibleFederation() are true .
MethodgetStepEnablerQuerySession
Description

Gets the OsidSession associated with the step enabler query service.

Returnosid.workflow.rules.StepEnablerQuerySessiona StepEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerQuery() is true .
MethodgetStepEnablerQuerySessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerQuerySessiona StepEnablerQuerySession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerQuery() and supportsVisibleFederation() are true .
MethodgetStepEnablerSearchSession
Description

Gets the OsidSession associated with the step enabler search service.

Returnosid.workflow.rules.StepEnablerSearchSessiona StepEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerSearch() is true .
MethodgetStepEnablerSearchSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerSearchSessiona StepEnablerSearchSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerSearch() and supportsVisibleFederation() are true .
MethodgetStepEnablerAdminSession
Description

Gets the OsidSession associated with the step enabler administration service.

Returnosid.workflow.rules.StepEnablerAdminSessiona StepEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerAdmin() is true .
MethodgetStepEnablerAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerAdminSessiona StepEnablerAdminSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetStepEnablerNotificationSession
Description

Gets the OsidSession associated with the step enabler notification service.

Parametersosid.workflow.rules.StepEnablerReceiverstepEnablerReceiverthe notification callback
Returnosid.workflow.rules.StepEnablerNotificationSessiona StepEnablerNotificationSession
ErrorsNULL_ARGUMENTstepReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerNotification() is true .
MethodgetStepEnablerNotificationSessionForOffice
Description

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

Parametersosid.workflow.rules.StepEnablerReceiverstepEnablerReceiverthe notification callback
osid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerNotificationSessiona StepEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTstepEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerNotification() and supportsVisibleFederation() are true .
MethodgetStepEnablerOfficeSession
Description

Gets the OsidSession to lookup step enabler/office mappings.

Returnosid.workflow.rules.StepEnablerOfficeSessiona StepEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerOffice() is true .
MethodgetStepEnablerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning step enablers to offices.

Returnosid.workflow.rules.StepEnablerOfficeAssignmentSessiona StepEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerOfficeAssignment() is true .
MethodgetStepEnablerSmartOfficeSession
Description

Gets the OsidSession to manage step enabler smart offices.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerSmartOfficeSessiona StepEnablerSmartOfficeSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerSmartOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerSmartOffice() is true .
MethodgetStepEnablerRuleLookupSession
Description

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

Returnosid.workflow.rules.StepEnablerRuleLookupSessiona StepEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerRuleLookup() is true .
MethodgetStepEnablerRuleLookupSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerRuleLookupSessiona StepEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetStepEnablerRuleApplicationSession
Description

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

Returnosid.workflow.rules.StepEnablerRuleApplicationSessiona StepEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerRuleApplication() is true .
MethodgetStepEnablerRuleApplicationSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepEnablerRuleApplicationSessiona StepEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetStepConstrainerLookupSession
Description

Gets the OsidSession associated with the step constrainer lookup service.

Returnosid.workflow.rules.StepConstrainerLookupSessiona StepConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerLookup() 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
Returnosid.workflow.rules.StepConstrainerLookupSessiona StepConstrainerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerLookup() 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.

Returnosid.workflow.rules.StepConstrainerQuerySessiona StepConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerQuery() 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
Returnosid.workflow.rules.StepConstrainerQuerySessiona StepConstrainerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerQuery() 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.

Returnosid.workflow.rules.StepConstrainerSearchSessiona StepConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerSearch() 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
Returnosid.workflow.rules.StepConstrainerSearchSessiona StepConstrainerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerSearch() 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.

Returnosid.workflow.rules.StepConstrainerAdminSessiona StepConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerAdmin() 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
Returnosid.workflow.rules.StepConstrainerAdminSessiona StepConstrainerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerAdmin() 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
Returnosid.workflow.rules.StepConstrainerNotificationSessiona StepConstrainerNotificationSession
ErrorsNULL_ARGUMENTstepConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerNotification() 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
Returnosid.workflow.rules.StepConstrainerNotificationSessiona StepConstrainerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTstepConstrainerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerNotification() 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.

Returnosid.workflow.rules.StepConstrainerOfficeSessiona StepConstrainerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerOffice() is true .
MethodgetStepConstrainerOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning step constrainer to office.

Returnosid.workflow.rules.StepConstrainerOfficeAssignmentSessiona StepConstrainerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerOfficeAssignment() 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
Returnosid.workflow.rules.StepConstrainerSmartOfficeSessiona StepConstrainerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerSmartOffice() 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 a step.

Returnosid.workflow.rules.StepConstrainerRuleLookupSessiona StepConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerRuleLookup() 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 step.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepConstrainerRuleLookupSessiona StepConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerRuleLookup() 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.

Returnosid.workflow.rules.StepConstrainerRuleApplicationSessiona StepConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerRuleApplication() 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
Returnosid.workflow.rules.StepConstrainerRuleApplicationSessiona StepConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerRuleApplication() 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.

Returnosid.workflow.rules.StepConstrainerEnablerLookupSessiona StepConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerLookup() 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
Returnosid.workflow.rules.StepConstrainerEnablerLookupSessiona StepConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerLookup() 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.

Returnosid.workflow.rules.StepConstrainerEnablerQuerySessiona StepConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerQuery() 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
Returnosid.workflow.rules.StepConstrainerEnablerQuerySessiona StepConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerQuery() 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.

Returnosid.workflow.rules.StepConstrainerEnablerSearchSessiona StepConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerSearch() 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
Returnosid.workflow.rules.StepConstrainerEnablerSearchSessiona StepConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerSearch() 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.

Returnosid.workflow.rules.StepConstrainerEnablerAdminSessiona StepConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerAdmin() 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
Returnosid.workflow.rules.StepConstrainerEnablerAdminSessiona StepConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerAdmin() 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
Returnosid.workflow.rules.StepConstrainerEnablerNotificationSessiona StepConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENTstepConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerNotification() 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
Returnosid.workflow.rules.StepConstrainerEnablerNotificationSessiona StepConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTstepConstrainerEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerNotification() 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.

Returnosid.workflow.rules.StepConstrainerEnablerOfficeSessiona StepConstrainerEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepConstrainerEnablerOffice() is true .
MethodgetStepConstrainerEnablerOfficeAssignmentSession
Description

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

Returnosid.workflow.rules.StepConstrainerEnablerOfficeAssignmentSessiona StepConstrainerEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerOfficeAssignment() 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
Returnosid.workflow.rules.StepConstrainerEnablerSmartOfficeSessiona StepConstrainerEnablerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerSmartOffice() 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.

Returnosid.workflow.rules.StepConstrainerEnablerRuleLookupSessiona StepConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerRuleLookup() 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
Returnosid.workflow.rules.StepConstrainerEnablerRuleLookupSessiona StepConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerRuleLookup() 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.

Returnosid.workflow.rules.StepConstrainerEnablerRuleApplicationSessiona StepConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerRuleApplication() 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
Returnosid.workflow.rules.StepConstrainerEnablerRuleApplicationSessiona StepConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepConstrainerEnablerRuleApplication() 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.

Returnosid.workflow.rules.StepProcessorLookupSessiona StepProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorLookup() 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
Returnosid.workflow.rules.StepProcessorLookupSessiona StepProcessorLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorLookup() 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.

Returnosid.workflow.rules.StepProcessorQuerySessiona StepProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorQuery() 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
Returnosid.workflow.rules.StepProcessorQuerySessiona StepProcessorQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorQuery() 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.

Returnosid.workflow.rules.StepProcessorSearchSessiona StepProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorSearch() 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
Returnosid.workflow.rules.StepProcessorSearchSessiona StepProcessorSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorSearch() 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.

Returnosid.workflow.rules.StepProcessorAdminSessiona StepProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorAdmin() 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
Returnosid.workflow.rules.StepProcessorAdminSessiona StepProcessorAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorAdmin() 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
Returnosid.workflow.rules.StepProcessorNotificationSessiona StepProcessorNotificationSession
ErrorsNULL_ARGUMENTstepProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorNotification() 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
Returnosid.workflow.rules.StepProcessorNotificationSessiona StepProcessorNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTstepProcessorReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorNotification() 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.

Returnosid.workflow.rules.StepProcessorOfficeSessiona StepProcessorOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorOffice() is true .
MethodgetStepProcessorOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning step processor to office.

Returnosid.workflow.rules.StepProcessorOfficeAssignmentSessiona StepProcessorOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorOfficeAssignment() 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
Returnosid.workflow.rules.StepProcessorSmartOfficeSessiona StepProcessorSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorSmartOffice() 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.

Returnosid.workflow.rules.StepProcessorRuleLookupSessiona StepProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorRuleLookup() 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
Returnosid.workflow.rules.StepProcessorRuleLookupSessiona StepProcessorRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorRuleLookup() 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.

Returnosid.workflow.rules.StepProcessorRuleApplicationSessiona StepProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorRuleApplication() 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.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepProcessorRuleApplicationSessiona StepProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorRuleApplication() 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.

Returnosid.workflow.rules.StepProcessorEnablerLookupSessiona StepProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerLookup() 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
Returnosid.workflow.rules.StepProcessorEnablerLookupSessiona StepProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerLookup() 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.

Returnosid.workflow.rules.StepProcessorEnablerQuerySessiona StepProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerQuery() 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
Returnosid.workflow.rules.StepProcessorEnablerQuerySessiona StepProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerQuery() 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.

Returnosid.workflow.rules.StepProcessorEnablerSearchSessiona StepProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerSearch() 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
Returnosid.workflow.rules.StepProcessorEnablerSearchSessiona StepProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerSearch() 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.

Returnosid.workflow.rules.StepProcessorEnablerAdminSessiona StepProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerAdmin() 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
Returnosid.workflow.rules.StepProcessorEnablerAdminSessiona StepProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerAdmin() 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
Returnosid.workflow.rules.StepProcessorEnablerNotificationSessiona StepProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENTstepProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerNotification() 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
Returnosid.workflow.rules.StepProcessorEnablerNotificationSessiona StepProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno office found by the given Id
NULL_ARGUMENTstepProcessorEnablerReceiver or officeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerNotification() 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.

Returnosid.workflow.rules.StepProcessorEnablerOfficeSessiona StepProcessorEnablerOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerOffice() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerOffice() is true .
MethodgetStepProcessorEnablerOfficeAssignmentSession
Description

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

Returnosid.workflow.rules.StepProcessorEnablerOfficeAssignmentSessiona StepProcessorEnablerOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerOfficeAssignment() 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
Returnosid.workflow.rules.StepProcessorEnablerSmartOfficeSessiona StepProcessorEnablerSmartOfficeSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerSmartOffice() 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.

Returnosid.workflow.rules.StepProcessorEnablerRuleLookupSessiona StepProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerRuleLookup() 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.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.workflow.rules.StepProcessorEnablerRuleLookupSessiona StepProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerRuleLookup() 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.

Returnosid.workflow.rules.StepProcessorEnablerRuleApplicationSessiona StepProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerRuleApplication() 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
Returnosid.workflow.rules.StepProcessorEnablerRuleApplicationSessiona StepProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsStepProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepProcessorEnablerRuleApplication() and supportsVisibleFederation() are true .