OSID Logo
OSID Specifications
subscription batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.batch.SubscriptionBatchManager
Implementsosid.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:

  • 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.SubscriptionBatchAdminSessiona SubscriptionBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionBatchAdmin() is false
ComplianceoptionalThis 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.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.batch.SubscriptionBatchAdminSessiona SubscriptionBatchAdminSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.DispatchBatchAdminSessiona DispatchBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchBatchAdmin() is false
ComplianceoptionalThis 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.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.batch.DispatchBatchAdminSessiona DispatchBatchAdminSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PublisherBatchAdminSessiona PublisherBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPublisherBatchAdmin() is true.