OSID Logo
OSID Specifications
subscription batch package
Version 3.1.0
Interfaceosid.subscription.batch.SubscriptionBatchManager
Implementsosid.OsidManager
osid.subscription.batch.SubscriptionBatchProfile
Used Byosid.subscription.SubscriptionManager
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:

  • SubscriptionBatchAdminSession: a session to create, modify and delete Subscriptions in bulk
  • DispatchBatchAdminSession: a session to create, modify and delete Dispatches in bulk
  • PublisherBatchAdminSession: a session to create, modify and delete Publishers in bulk
MethodgetSubscriptionBatchAdminSession
Description

Gets the OsidSession associated with the bulk subscription administration service.

Returnosid.subscription.batch.SubscriptionBatchAdminSession a SubscriptionBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubscriptionBatchAdmin() is false
Complianceoptional This method must be implemented if supportsSubscriptionBatchAdmin() is true.
MethodgetSubscriptionBatchAdminSessionForPublisher
Description

Gets the OsidSession associated with the bulk subscription administration service for the given publisher.

Parametersosid.id.IdpublisherId the Id of the Publisher
Returnosid.subscription.batch.SubscriptionBatchAdminSession a SubscriptionBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsSubscriptionBatchAdmin() and supportsVisibleFederation() are true
MethodgetDispatchBatchAdminSession
Description

Gets the OsidSession associated with the bulk dispatch administration service.

Returnosid.subscription.batch.DispatchBatchAdminSession a DispatchBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDispatchBatchAdmin() is false
Complianceoptional This method must be implemented if supportsDispatchBatchAdmin() is true.
MethodgetDispatchBatchAdminSessionForPublisher
Description

Gets the OsidSession associated with the bulk dispatch administration service for the given publisher.

Parametersosid.id.IdpublisherId the Id of the Publisher
Returnosid.subscription.batch.DispatchBatchAdminSession a DispatchBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsDispatchBatchAdmin() and supportsVisibleFederation() are true
MethodgetPublisherBatchAdminSession
Description

Gets the OsidSession associated with the bulk publisher administration service.

Returnosid.subscription.batch.PublisherBatchAdminSession a PublisherBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPublisherBatchAdmin() is false
Complianceoptional This method must be implemented if supportsPublisherBatchAdmin() is true.