org.osid.subscription.batch

Interface SubscriptionBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, SubscriptionBatchProfile

public interface SubscriptionBatchProxyManager
extends OsidProxyManager, SubscriptionBatchProfile

The subscription batch proxy manager provides access to subscription batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• SubscriptionBatchAdminSession: a session to manage subscriptions in bulk
• DispatchBatchAdminSession: a session to manage dispatches in bulk
• PublisherBatchAdminSession: a session to create, modify and delete Publishers in bulk

Method Summary

Methods

Modifier and Type	Method and Description
DispatchBatchAdminSession	getDispatchBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk dispatch administration service.
DispatchBatchAdminSession	getDispatchBatchAdminSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the bulk dispatch administration service for the given publisher.
PublisherBatchAdminSession	getPublisherBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk publisher administration service.
DispatchBatchAdminSession	getSubscriptionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk work administration service.
SubscriptionBatchAdminSession	getSubscriptionBatchAdminSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the bulk subscription administration service for the given publisher.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.subscription.batch.SubscriptionBatchProfile

supportsDispatchBatchAdmin, supportsPublisherBatchAdmin, supportsSubscriptionBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSubscriptionBatchAdminSession

DispatchBatchAdminSession getSubscriptionBatchAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk work administration service.

Parameters:

proxy - a proxy

Returns:

a DispatchBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionBatchAdmin() is true.

getSubscriptionBatchAdminSessionForPublisher

SubscriptionBatchAdminSession getSubscriptionBatchAdminSessionForPublisher(Id publisherId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionBatchAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionBatchAdmin() and supportsVisibleFederation() are true

getDispatchBatchAdminSession

DispatchBatchAdminSession getDispatchBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk dispatch administration service.

Parameters:

proxy - a proxy

Returns:

a DispatchBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsDispatchBatchAdmin() is true.

getDispatchBatchAdminSessionForPublisher

DispatchBatchAdminSession getDispatchBatchAdminSessionForPublisher(Id publisherId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a DispatchBatchAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDispatchBatchAdmin() and supportsVisibleFederation() are true

getPublisherBatchAdminSession

PublisherBatchAdminSession getPublisherBatchAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk publisher administration service.

Parameters:

proxy - a proxy

Returns:

a PublisherBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPublisherBatchAdmin() is true.