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 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. |
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
DispatchBatchAdminSession getSubscriptionBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk work
administration service.proxy
- a proxy DispatchBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionBatchAdmin()
is false
optional
- This method must be implemented if
supportsSubscriptionBatchAdmin()
is true.
SubscriptionBatchAdminSession getSubscriptionBatchAdminSessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
subscription administration service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionBatchAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk dispatch
administration service.proxy
- a proxy DispatchBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDispatchBatchAdmin()
is false
optional
- This method must be implemented if
supportsDispatchBatchAdmin()
is true.
DispatchBatchAdminSession getDispatchBatchAdminSessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk dispatch
administration service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy DispatchBatchAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk publisher
administration service.proxy
- a proxy PublisherBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPublisherBatchAdmin()
is false
optional
- This method must be implemented if
supportsPublisherBatchAdmin()
is true.