Interface | osid.workflow.WorkflowManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.workflow.WorkflowProfile | |||
Description |
The workflow manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getProcessLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessLookupSession | a ProcessLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProcessLookup()
is true. | |
Method | getProcessLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.ProcessLookupSession | a ProcessLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessLookup()
and supportsVisibleFederation() are true | |
Method | getProcessQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessQuerySession | a ProcessQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProcessQuery() is
true. | |
Method | getProcessQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.ProcessQuerySession | a ProcessQuerySession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProcessQuery()
and supportsVisibleFederation() are true | |
Method | getProcessSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessSearchSession | a ProcessSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProcessSearch()
is true. | |
Method | getProcessSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.ProcessSearchSession | a ProcessSearchSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessSearch()
and supportsVisibleFederation() are true | |
Method | getProcessAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessAdminSession | a ProcessAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProcessAdmin() is
true. | |
Method | getProcessAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.ProcessAdminSession | a ProcessAdminSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProcessAdmin()
and supportsVisibleFederation() are true | |
Method | getProcessNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.ProcessReceiver | processReceiver | the notification callback |
Return | osid.workflow.ProcessNotificationSession | a ProcessNotificationSession | |
Errors | NULL_ARGUMENT | processReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProcessNotification()
is true. | |
Method | getProcessNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.ProcessReceiver | processReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.ProcessNotificationSession | a ProcessNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | processReceiver or officeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessNotification()
and supportsVisibleFederation() are true | |
Method | getProcessOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessOfficeSession | a ProcessOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessOffice() is false | ||
Compliance | optional | This method must be implemented if supportsProcessOffice()
is true. | |
Method | getProcessOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.ProcessOfficeAssignmentSession | a ProcessOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessOfficeAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsProcessOfficeAssignment()
is true. | |
Method | getProcessSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.ProcessSmartOfficeSession | a ProcessSmartOfficeSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessSmartOffice() is false | ||
Compliance | optional | This method must be implemented if supportsProcessSmartOffice()
is true. | |
Method | getStepLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.StepLookupSession | a StepLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepLookup() is false | ||
Compliance | optional | This method must be implemented if supportsStepLookup() is
true. | |
Method | getStepLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.StepLookupSession | a StepLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsStepLookup() and
supportsVisibleFederation() are true | |
Method | getStepQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.StepQuerySession | a StepQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepQuery() is false | ||
Compliance | optional | This method must be implemented if supportsStepQuery() is
true. | |
Method | getStepQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.StepQuerySession | a StepQuerySession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsStepQuery() and
supportsVisibleFederation() are true | |
Method | getStepSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.StepSearchSession | a StepSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepSearch() is false | ||
Compliance | optional | This method must be implemented if supportsStepSearch() is
true. | |
Method | getStepSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.StepSearchSession | a StepSearchSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsStepSearch() and
supportsVisibleFederation() are true | |
Method | getStepAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.StepAdminSession | a StepAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStepAdmin() is
true. | |
Method | getStepAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.StepAdminSession | a StepAdminSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsStepAdmin() and
supportsVisibleFederation() are true | |
Method | getStepNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.StepReceiver | stepReceiver | the notification callback |
Return | osid.workflow.StepNotificationSession | a StepNotificationSession | |
Errors | NULL_ARGUMENT | stepReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepNotification() is false | ||
Compliance | optional | This method must be implemented if supportsStepNotification()
is true. | |
Method | getStepNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.StepReceiver | stepReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.StepNotificationSession | a StepNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | stepReceiver or officeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepNotification()
and supportsVisibleFederation() are true | |
Method | getStepOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.StepOfficeSession | a StepOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepOffice() is false | ||
Compliance | optional | This method must be implemented if supportsStepOffice() is
true. | |
Method | getStepOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.StepOfficeAssignmentSession | a StepOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepOfficeAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsStepOfficeAssignment()
is true. | |
Method | getStepSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.StepOfficeSession | a StepSmartOfficeSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepSmartOffice() is false | ||
Compliance | optional | This method must be implemented if supportsStepSmartOffice()
is true. | |
Method | getWorkLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkLookupSession | a WorkLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkLookup() is false | ||
Compliance | optional | This method must be implemented if supportsWorkLookup() is
true. | |
Method | getWorkLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkLookupSession | a WorkLookupSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsWorkLookup() and
supportsVisibleFederation() are true | |
Method | getWorkQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkQuerySession | a WorkQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkQuery() is false | ||
Compliance | optional | This method must be implemented if supportsWorkQuery() is
true. | |
Method | getWorkQuerySessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkQuerySession | a WorkQuerySession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsWorkQuery() and
supportsVisibleFederation() are true | |
Method | getWorkSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkSearchSession | a WorkSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkSearch() is false | ||
Compliance | optional | This method must be implemented if supportsWorkSearch() is
true. | |
Method | getWorkSearchSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkSearchSession | a WorkSearchSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsWorkSearch() and
supportsVisibleFederation() are true | |
Method | getWorkAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkAdminSession | a WorkAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsWorkAdmin() is
true. | |
Method | getWorkAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkAdminSession | a WorkAdminSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsWorkAdmin() and
supportsVisibleFederation() are true | |
Method | getWorkNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.WorkReceiver | workReceiver | the notification callback |
Return | osid.workflow.WorkNotificationSession | a WorkNotificationSession | |
Errors | NULL_ARGUMENT | workReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkNotification() is false | ||
Compliance | optional | This method must be implemented if supportsWorkNotification()
is true. | |
Method | getWorkNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.WorkReceiver | workReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.WorkNotificationSession | a WorkNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | workReceiver or officeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsWorkNotification()
and supportsVisibleFederation() are true | |
Method | getWorkOfficeSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkOfficeSession | a WorkOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkOffice() is false | ||
Compliance | optional | This method must be implemented if supportsWorkOffice() is
true. | |
Method | getWorkOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkOfficeAssignmentSession | a WorkOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkbOfficeAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsWorkOfficeAssignment()
is true. | |
Method | getWorkSmartOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkSmartOfficeSession | a WorkSmartOfficeSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkSmartOffice() is false | ||
Compliance | optional | This method must be implemented if supportsWorkSmartOffice()
is true. | |
Method | getWorkflowSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkflowSession | a WorkflowSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflow() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflow() is
true. | |
Method | getWorkflowSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkflowSession | a WorkflowSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflow() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsWorkflow() and
supportsVisibleFederation() are true | |
Method | getWorkflowInitiationSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkflowInitiationSession | a WorkflowInitiationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflowInitiation() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowInitiation()
is true. | |
Method | getWorkflowInitiationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkflowInitiationSession | a WorkflowInitiationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | offiecId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflowInitiation() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowInitiation()
and supportsVisibleFederation() are true | |
Method | getWorkflowManagementSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkflowManagementSession | a WorkflowManagementSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflowManagement() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowManagement()
is true. | |
Method | getWorkflowManagementSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.WorkflowManagementSession | a WorkflowManagementSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflowManagement() or supportsVisibleFederation() is false
| ||
Compliance | optional | This method must be implemented if supportsWorkflowManagement()
and supportsVisibleFederation() are true | |
Method | getManualWorkflowSession | ||
Description |
Gets the | ||
Return | osid.workflow.ManualWorkflowSession | a ManualWorkflowSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsManualWorkflow() is false | ||
Compliance | optional | This method must be implemented if supportsManualWorkflow()
is true. | |
Method | getManualWorkflowSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the office |
Return | osid.workflow.ManualWorkflowSession | a ManualWorkflowSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsManualWorkflow() or supportsVisibleFederation() is false
| ||
Compliance | optional | This method must be implemented if supportsManualWorkflow()
and supportsVisibleFederation() are true | |
Method | getWorkflowEventLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.WorkflowEventLookupSession | a WorkflowLogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflowEventLookup() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowEventLookup()
is true. | |
Method | getWorkflowEventLookupSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the office |
Return | osid.workflow.WorkflowEventLookupSession | a WorkflowEventLookupSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflowEventLookup() or supportsVisibleFederation() is
false | ||
Compliance | optional | This method must be implemented if supportsWorkflowEventLookup()
and supportsVisibleFederation() are true | |
Method | getWorkflowEventNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.WorkflowEventReceiver | workflowEventReceiver | the notification callback |
Return | osid.workflow.WorkflowEventNotificationSession | a WorkflowEventNotificationSession | |
Errors | NULL_ARGUMENT | workflowEventReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflowEventNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsWorkflowEventNotification() is true | |
Method | getWorkflowEventNotificationSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.workflow.WorkflowEventReceiver | workflowEventReceiver | the notification callback |
osid.id.Id | officeId | the Id of the Office | |
Return | osid.workflow.WorkflowEventNotificationSession | a WorkflowEventNotificationSession | |
Errors | NOT_FOUND | no office found by the given Id | |
NULL_ARGUMENT | workflowEventReceiver or officeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkflowEventNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsWorkflowEventNotification() and
supportsVisibleFederation() are true | |
Method | getOfficeLookupSession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeLookupSession | a OfficeLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeLookup() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeLookup() is
true. | |
Method | getOfficeQuerySession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeQuerySession | a OfficeQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeQuery() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeQuery() is
true. | |
Method | getOfficeSearchSession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeSearchSession | a OfficeSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeSearch() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeSearch() is
true. | |
Method | getOfficeAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeAdminSession | a OfficeAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeAdmin() is
true. | |
Method | getOfficeNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.workflow.OfficeReceiver | officeReceiver | the notification callback |
Return | osid.workflow.OfficeNotificationSession | a OfficeNotificationSession | |
Errors | NULL_ARGUMENT | officeReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfficeNotification() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeNotification()
is true. | |
Method | getOfficeHierarchySession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeHierarchySession | a OfficeHierarchySession for offices | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeHierarchy()
is true. | |
Method | getOfficeHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.workflow.OfficeHierarchyDesignSession | a HierarchyDesignSession for offices | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeHierarchyDesign()
is true. | |
Method | getWorkflowBatchManager | ||
Description |
Gets a | ||
Return | osid.workflow.batch.WorkflowBatchManager | a WorkflowbatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflowBatch() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowBatch()
is true. | |
Method | getWorkflowRulesManager | ||
Description |
Gets a | ||
Return | osid.workflow.rules.WorkflowRulesManager | a WorkflowRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkflowRules() is false | ||
Compliance | optional | This method must be implemented if supportsWorkflowRules()
is true. |