Interface | osid.tracking.batch.TrackingBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.tracking.batch.TrackingBatchProfile | |||
Description |
The tracking batch manager provides access to tracking batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getIssueBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.batch.IssueBatchAdminSession | a IssueBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsIssueBatchAdmin()
is true. | |
Method | getIssueBatchAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.batch.IssueBatchAdminSession | a IssueBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getSubtaskIssueBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.batch.SubtaskIssueBatchAdminSession | a SubtaskBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubtaskBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskBatchAdmin()
is true. | |
Method | getSubtaskIssueBatchAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.batch.SubtaskIssueBatchAdminSession | a SubtaskBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubtaskBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getQueueBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsQueueBatchAdmin()
is true. | |
Method | getQueueBatchAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsQueueBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getFrontOfficeBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.batch.FrontOfficeBatchAdminSession | a FrontOfficeBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeBatchAdmin()
is true. |