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

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface SubscriptionBatchProfile

supportsDispatchBatchAdmin, supportsPublisherBatchAdmin, supportsSubscriptionBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsDispatchBatchAdmin()	Tests if bulk administration of dispatches is available.
boolean	supportsPublisherBatchAdmin()	Tests if bulk administration of publishers is available.
boolean	supportsSubscriptionBatchAdmin()	Tests if bulk administration of subscriptions is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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} .