Interface SubscriptionBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, SubscriptionBatchProfile
public interface SubscriptionBatchManager extends OsidManager, SubscriptionBatchProfile

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
SubscriptionBatchManager may be accessed by multiple processing threads.

  • Method Details

    • getSubscriptionBatchAdminSession

      SubscriptionBatchAdminSession getSubscriptionBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk subscription administration service.
      Returns:
      a SubscriptionBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionBatchAdmin()} is {@code true}.

    • getSubscriptionBatchAdminSessionForPublisher

      SubscriptionBatchAdminSession getSubscriptionBatchAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk subscription administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionBatchAdminSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchBatchAdminSession

      DispatchBatchAdminSession getDispatchBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk dispatch administration service.
      Returns:
      a DispatchBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchBatchAdmin()} is {@code true}.

    • getDispatchBatchAdminSessionForPublisher

      DispatchBatchAdminSession getDispatchBatchAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk dispatch administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchBatchAdminSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getPublisherBatchAdminSession

      PublisherBatchAdminSession getPublisherBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk publisher administration service.
      Returns:
      a PublisherBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPublisherBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPublisherBatchAdmin()} is {@code true}.