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 Modifier and Type | Method and 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. |
changeBranch, initialize, rollbackService
close
supportsDispatchBatchAdmin, supportsPublisherBatchAdmin, supportsSubscriptionBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
SubscriptionBatchAdminSession getSubscriptionBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
subscription administration service. SubscriptionBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionBatchAdmin()
is false
optional
- This method must be implemented if
supportsSubscriptionBatchAdmin()
is true.
SubscriptionBatchAdminSession getSubscriptionBatchAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
subscription administration service for the given publisher.publisherId
- the Id
of the Publisher
SubscriptionBatchAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionBatchAdmin()
and
supportsVisibleFederation()
are true
DispatchBatchAdminSession getDispatchBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk dispatch
administration service. DispatchBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDispatchBatchAdmin()
is false
optional
- This method must be implemented if
supportsDispatchBatchAdmin()
is true.
DispatchBatchAdminSession getDispatchBatchAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk dispatch
administration service for the given publisher.publisherId
- the Id
of the Publisher
DispatchBatchAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDispatchBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDispatchBatchAdmin()
and
supportsVisibleFederation()
are true
PublisherBatchAdminSession getPublisherBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk publisher
administration service. PublisherBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPublisherBatchAdmin()
is false
optional
- This method must be implemented if
supportsPublisherBatchAdmin()
is true.