Interface | osid.subscription.batch.SubscriptionBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.subscription.batch.SubscriptionBatchProfile | |||
Description |
The subscription batch manager provides access to subscription batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getSubscriptionBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.subscription.batch.SubscriptionBatchAdminSession | a SubscriptionBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubscriptionBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionBatchAdmin()
is true. | |
Method | getSubscriptionBatchAdminSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
Return | osid.subscription.batch.SubscriptionBatchAdminSession | a SubscriptionBatchAdminSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getDispatchBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.subscription.batch.DispatchBatchAdminSession | a DispatchBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDispatchBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchBatchAdmin()
is true. | |
Method | getDispatchBatchAdminSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
Return | osid.subscription.batch.DispatchBatchAdminSession | a DispatchBatchAdminSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getPublisherBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.subscription.batch.PublisherBatchAdminSession | a PublisherBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPublisherBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherBatchAdmin()
is true. |