Interface | osid.tracking.batch.TrackingBatchProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.tracking.batch.TrackingBatchProfile | |||
Description |
The tracking batch proxy manager provides access to
tracking batch sessions and provides interoperability tests
for various aspects of this service. Methods in this manager
support the passing of a
| ||
Method | getIssueBatchAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.tracking.batch.IssueBatchAdminSession | a IssueBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.tracking.batch.IssueBatchAdminSession | a IssueBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.tracking.batch.SubtaskIssueBatchAdminSession | a SubtaskIssueBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubtaskIssueBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueBatchAdmin()
is true. | |
Method | getSubtaskIssueBatchAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.tracking.batch.SubtaskIssueBatchAdminSession | a SubtaskIssueBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubtaskIssueBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getQueueBatchAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.tracking.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.tracking.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.tracking.batch.FrontOfficeBatchAdminSession | a FrontOfficeBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFrontOfficeBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeBatchAdmin()
is true. |