Interface | osid.workflow.rules.WorkflowRulesManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.workflow.rules.WorkflowRulesProfile | |||
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:
| ||
Method | getStepConstrainerLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerLookupSession | a StepConstrainerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerLookup()
is true. | |
Method | getStepConstrainerLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerLookupSession | a StepConstrainerLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerLookup()
and supportsVisibleFederation() are true.
| |
Method | getStepConstrainerQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerQuerySession | a StepConstrainerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerQuery()
is true. | |
Method | getStepConstrainerQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerQuerySession | a StepConstrainerQuerySession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerQuery()
and supportsVisibleFederation() are true.
| |
Method | getStepConstrainerSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerSearchSession | a StepConstrainerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerSearch()
is true. | |
Method | getStepConstrainerSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerSearchSession | a StepConstrainerSearchSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerSearch()
and supportsVisibleFederation() are true.
| |
Method | getStepConstrainerAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerAdminSession | a StepConstrainerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerAdmin()
is true. | |
Method | getStepConstrainerAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerAdminSession | a StepConstrainerAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getStepConstrainerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepConstrainerReceiver | stepConstrainerReceiver | the notification callback |
Return | osid.workflow.rules.StepConstrainerNotificationSession | a StepConstrainerNotificationSession | |
Errors | NULL_ARGUMENT | stepConstrainerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerNotification() is true. | |
Method | getStepConstrainerNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepConstrainerReceiver | stepConstrainerReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.rules.StepConstrainerNotificationSession | a StepConstrainerNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | stepConstrainerReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerNotification() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerOfficeSession | a StepConstrainerOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerOffice() is false | ||
Compliance | optional | This method must be implemented if supportsStepConstrainerOffice()
is true. | |
Method | getStepConstrainerOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerOfficeAssignmentSession | a StepConstrainerOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerOfficeAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerOfficeAssignment() is true. | |
Method | getStepConstrainerSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerSmartOfficeSession | a StepConstrainerSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerSmartOffice() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerSmartOffice() is true. | |
Method | getStepConstrainerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerRuleLookupSession | a StepConstrainerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerRuleLookup() is true. | |
Method | getStepConstrainerRuleLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerRuleLookupSession | a StepConstrainerRuleLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerRuleApplicationSession | a StepConstrainerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerRuleApplication() is true. | |
Method | getStepConstrainerRuleApplicationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerRuleApplicationSession | a StepConstrainerRuleApplicationSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerLookupSession | a StepConstrainerEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerLookup() is true. | |
Method | getStepConstrainerEnablerLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerLookupSession | a StepConstrainerEnablerLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerLookup() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerQuerySession | a StepConstrainerEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerQuery() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerQuery() is true. | |
Method | getStepConstrainerEnablerQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerQuerySession | a StepConstrainerEnablerQuerySession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerQuery() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerSearchSession | a StepConstrainerEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerSearch() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerSearch() is true. | |
Method | getStepConstrainerEnablerSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerSearchSession | a StepConstrainerEnablerSearchSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerSearch() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerAdminSession | a StepConstrainerEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerAdmin() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerAdmin() is true. | |
Method | getStepConstrainerEnablerAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerAdminSession | a StepConstrainerEnablerAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerAdmin() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepConstrainerEnablerReceiver | stepConstrainerEnablerReceiver | the notification callback |
Return | osid.workflow.rules.StepConstrainerEnablerNotificationSession | a StepConstrainerEnablerNotificationSession | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerNotification() is true. | |
Method | getStepConstrainerEnablerNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepConstrainerEnablerReceiver | stepConstrainerEnablerReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.rules.StepConstrainerEnablerNotificationSession | a StepConstrainerEnablerNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | stepConstrainerEnablerReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerOfficeSession | a StepConstrainerEnablerOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerOffice() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerOffice() is true. | |
Method | getStepConstrainerEnablerOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerOfficeAssignmentSession | a StepConstrainerEnablerOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerOfficeAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerOfficeAssignment() is true.
| |
Method | getStepConstrainerEnablerSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerSmartOfficeSession | a StepConstrainerEnablerSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerSmartOffice() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerSmartOffice() is true. | |
Method | getStepConstrainerEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerRuleLookupSession | a StepConstrainerEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerRuleLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerRuleLookup() is true. | |
Method | getStepConstrainerEnablerRuleLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerRuleLookupSession | a StepConstrainerEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getStepConstrainerEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepConstrainerEnablerRuleApplicationSession | a StepConstrainerEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepConstrainerEnablerRuleApplication() is
false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerRuleApplication() is true.
| |
Method | getStepConstrainerEnablerRuleApplicationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepConstrainerEnablerRuleApplicationSession | a StepConstrainerEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepConstrainerEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepConstrainerEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorLookupSession | a StepProcessorLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorLookup() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorLookup()
is true. | |
Method | getStepProcessorLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorLookupSession | a StepProcessorLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorLookup()
and supportsVisibleFederation() are true.
| |
Method | getStepProcessorQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorQuerySession | a StepProcessorQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorQuery() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorQuery()
is true. | |
Method | getStepProcessorQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorQuerySession | a StepProcessorQuerySession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorQuery()
and supportsVisibleFederation() are true.
| |
Method | getStepProcessorSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorSearchSession | a StepProcessorSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorSearch() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorSearch()
is true. | |
Method | getStepProcessorSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorSearchSession | a StepProcessorSearchSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorSearch()
and supportsVisibleFederation() are true.
| |
Method | getStepProcessorAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorAdminSession | a StepProcessorAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorAdmin()
is true. | |
Method | getStepProcessorAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorAdminSession | a StepProcessorAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorAdmin()
and supportsVisibleFederation() are true.
| |
Method | getStepProcessorNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepProcessorReceiver | stepProcessorReceiver | the notification callback |
Return | osid.workflow.rules.StepProcessorNotificationSession | a StepProcessorNotificationSession | |
Errors | NULL_ARGUMENT | stepProcessorReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorNotification() is true. | |
Method | getStepProcessorNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepProcessorReceiver | stepProcessorReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.rules.StepProcessorNotificationSession | a StepProcessorNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | stepProcessorReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorNotification() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorOfficeSession | a StepProcessorOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorOffice() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorOffice()
is true. | |
Method | getStepProcessorOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorOfficeAssignmentSession | a StepProcessorOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorOfficeAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepProcessorOfficeAssignment() is true. | |
Method | getStepProcessorSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorSmartOfficeSession | a StepProcessorSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorSmartOffice() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorSmartOffice() is true. | |
Method | getStepProcessorRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorRuleLookupSession | a StepProcessorRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorRuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorRuleLookup()
is true. | |
Method | getStepProcessorRuleLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorRuleLookupSession | a StepProcessorRuleLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepProcessorRuleLookup()
and supportsVisibleFederation() are true.
| |
Method | getStepProcessorRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorRuleApplicationSession | a StepProcessorRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepProcessorRuleApplication() is true. | |
Method | getStepProcessorRuleApplicationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorRuleApplicationSession | a StepProcessorRuleApplicationSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerLookupSession | a StepProcessorEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerLookup() is true. | |
Method | getStepProcessorEnablerLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerLookupSession | a StepProcessorEnablerLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerLookup() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerQuerySession | a StepProcessorEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerQuery() is true. | |
Method | getStepProcessorEnablerQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerQuerySession | a StepProcessorEnablerQuerySession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerQuery() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerSearchSession | a StepProcessorEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerSearch() is true. | |
Method | getStepProcessorEnablerSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerSearchSession | a StepProcessorEnablerSearchSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerSearch() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerAdminSession | a StepProcessorEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerAdmin() is true. | |
Method | getStepProcessorEnablerAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerAdminSession | a StepProcessorEnablerAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerAdmin() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepProcessorEnablerReceiver | stepProcessorEnablerReceiver | the notification callback |
Return | osid.workflow.rules.StepProcessorEnablerNotificationSession | a StepProcessorEnablerNotificationSession | |
Errors | NULL_ARGUMENT | stepProcessorEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerNotification() is true. | |
Method | getStepProcessorEnablerNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.StepProcessorEnablerReceiver | stepProcessorEnablerReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.rules.StepProcessorEnablerNotificationSession | a StepProcessorEnablerNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | stepProcessorEnablerReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerOfficeSession | a StepProcessorEnablerOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerOffice() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerOffice() is true. | |
Method | getStepProcessorEnablerOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerOfficeAssignmentSession | a StepProcessorEnablerOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerOfficeAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerOfficeAssignment() is true. | |
Method | getStepProcessorEnablerSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerSmartOfficeSession | a StepProcessorEnablerSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerSmartOffice() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerSmartOffice() is true. | |
Method | getStepProcessorEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerRuleLookupSession | a StepProcessorEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerRuleLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerRuleLookup() is true. | |
Method | getStepProcessorEnablerRuleLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerRuleLookupSession | a StepProcessorEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getStepProcessorEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.StepProcessorEnablerRuleApplicationSession | a StepProcessorEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepProcessorEnablerRuleApplication() is
false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerRuleApplication() is true. | |
Method | getStepProcessorEnablerRuleApplicationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.StepProcessorEnablerRuleApplicationSession | a StepProcessorEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepProcessorEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsStepProcessorEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getProcessEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerLookupSession | a ProcessEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerLookup()
is true. | |
Method | getProcessEnablerLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerLookupSession | a ProcessEnablerLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getProcessEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerQuerySession | a ProcessEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerQuery()
is true. | |
Method | getProcessEnablerQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerQuerySession | a ProcessEnablerQuerySession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getProcessEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerSearchSession | a ProcessEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerSearch()
is true. | |
Method | getProcessEnablerSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerSearchSession | a ProcessEnablerSearchSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getProcessEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerAdminSession | a ProcessEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerAdmin()
is true. | |
Method | getProcessEnablerAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerAdminSession | a ProcessEnablerAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getProcessEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.ProcessEnablerReceiver | processEnablerReceiver | the notification callback |
Return | osid.workflow.rules.ProcessEnablerNotificationSession | a ProcessEnablerNotificationSession | |
Errors | NULL_ARGUMENT | processEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerNotification() is true. | |
Method | getProcessEnablerNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.rules.ProcessEnablerReceiver | processEnablerReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.rules.ProcessEnablerNotificationSession | a ProcessEnablerNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | processEnablerReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getProcessEnablerOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerOfficeSession | a ProcessEnablerOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerOffice() is false | ||
Compliance | optional | This method must be implemented if supportsProcessEnablerOffice()
is true. | |
Method | getProcessEnablerOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerOfficeAssignmentSession | a ProcessEnablerOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerOfficeAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerOfficeAssignment() is true. | |
Method | getProcessEnablerSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerSmartOfficeSession | a ProcessEnablerSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerSmartOffice() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerSmartOffice() is true. | |
Method | getProcessEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerRuleLookupSession | a ProcessEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerRuleLookup() is true. | |
Method | getProcessEnablerRuleLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerRuleLookupSession | a ProcessEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getProcessEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.workflow.rules.ProcessEnablerRuleApplicationSession | a ProcessEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerRuleApplication() is true. | |
Method | getProcessEnablerRuleApplicationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.rules.ProcessEnablerRuleApplicationSession | a ProcessEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProcessEnablerRuleApplication() and
supportsVisibleFederation() are true. |