Interface | osid.workflow.batch.WorkflowBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.workflow.batch.WorkflowBatchProfile | |||
Description |
The workflow batch manager provides access to workflow batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getProcessBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.batch.ProcessBatchAdminSession | a ProcessBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProcessBatchAdmin()
is true. | |
Method | getProcessBatchAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.batch.ProcessBatchAdminSession | a ProcessBatchAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcessBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getStepBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.batch.StepBatchAdminSession | a StepBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStepBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStepBatchAdmin()
is true. | |
Method | getStepBatchAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.batch.StepBatchAdminSession | a StepBatchAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStepBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsStepBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getWorkBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.batch.WorkBatchAdminSession | a WorkBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsWorkBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsWorkBatchAdmin()
is true. | |
Method | getWorkBatchAdminSessionForOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
Return | osid.workflow.batch.WorkBatchAdminSession | a WorkBatchAdminSession | |
Errors | NOT_FOUND | no Office found by the given Id | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWorkBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsWorkBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getOfficeBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.workflow.batch.OfficeBatchAdminSession | a OfficeBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfficeBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOfficeBatchAdmin()
is true. |