Interface SubscriptionManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, SubscriptionProfile

public interface SubscriptionManager
extends OsidManager, SubscriptionProfile

The subscription manager provides access to subscription sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• MySubscriptionSession : a session to look up subscriptions
• MySubscriptionAdminSession : a session to manage subscriptions
• SubscriptionLookupSession : a session to lookup subscriptions
• SubscriptionQuerySession : a session to query subscriptions
• SubscriptionSearchSession : a session to search subscriptions
• SubscriptionAdminSession : a session to manage subscriptions
• SubscriptionNotificationSession : a session to subscribe to notifications of subscription changes
• SubscriptionPublisherSession : a session to look up subscription publisher mappings
• SubscriptionPublisherAssignmentSession : a session to manage subscription publisher mappings
• SubscriptionSmartPublisherSession : a session to manage smart publishers of subscriptions
• DispatchLookupSession : a session to retrieve dispatches
• DispatchQuerySession : a session to query dispatches
• DispatchSearchSession : a session to search for dispatches
• DispatchAdminSession : a session to create, update and delete dispatches
• DispatchNotificationSession : a session to receive notifications for changes in dispatches
• DispatchPublisherSession : a session to look up dispatch publisher mappings
• DispatchPublisherAssignmentSession : a session to manage dispatch publisher mappings
• DispatchSmartPublisherSession : a session to manage smart publishers of dispatches

• PublisherLookupSession : a session to retrieve publishers
• PublisherQuerySession : a session to query publishers
• PublisherSearchSession : a session to search for publishers
• PublisherAdminSession : a session to create, update and delete publishers
• PublisherNotificationSession : a session to receive notifications for changes in publishers
• PublisherHierarchySession : a session to traverse hierarchies of publishers
• PublisherHierarchyDesignSession : a session to manage hierarchies of publishers

The subscription manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Modifier and Type	Method	Description
DispatchAdminSession	getDispatchAdminSession()	Gets the OsidSession associated with the dispatch administrative service.
DispatchAdminSession	getDispatchAdminSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the dispatch administrative service for the given publisher.
DispatchLookupSession	getDispatchLookupSession()	Gets the OsidSession associated with the dispatch lookup service.
DispatchLookupSession	getDispatchLookupSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the dispatch lookup service for the given publisher.
DispatchNotificationSession	getDispatchNotificationSession(DispatchReceiver dispatchReceiver)	Gets the OsidSession associated with the dispatch notification service.
DispatchNotificationSession	getDispatchNotificationSessionForPublisher(DispatchReceiver dispatchReceiver, Id publisherId)	Gets the OsidSession associated with the dispatch notification service for the given publisher.
DispatchPublisherAssignmentSession	getDispatchPublisherAssignmentSession()	Gets the session for assigning dispatch to publisher mappings.
DispatchPublisherSession	getDispatchPublisherSession()	Gets the session for retrieving dispatch to publisher mappings.
DispatchQuerySession	getDispatchQuerySession()	Gets the OsidSession associated with the dispatch query service.
DispatchQuerySession	getDispatchQuerySessionForPublisher(Id publisherId)	Gets the OsidSession associated with the dispatch query service for the given publisher.
DispatchSearchSession	getDispatchSearchSession()	Gets the OsidSession associated with the dispatch search service.
DispatchSearchSession	getDispatchSearchSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the dispatch search service for the given publisher.
DispatchSmartPublisherSession	getDispatchSmartPublisherSession(Id publisherId)	Gets the session associated with the dispatch smart publisher for the given publisher.
MySubscriptionAdminSession	getMySubscriptionAdminSession()	Gets the OsidSession associated with the subscription administrative service for the authenticated agent.
MySubscriptionAdminSession	getMySubscriptionAdminSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription administrative service for the authenticated agent for the given publisher.
MySubscriptionSession	getMySubscriptionSession()	Gets the OsidSession associated with the subscription lookup service for the authenticated agent.
MySubscriptionSession	getMySubscriptionSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription lookup service for the authenticated agent for the given publisher.
PublisherAdminSession	getPublisherAdminSession()	Gets the OsidSession associated with the publisher administrative service.
PublisherHierarchyDesignSession	getPublisherHierarchyDesignSession()	Gets the OsidSession associated with the publisher hierarchy design service.
PublisherHierarchySession	getPublisherHierarchySession()	Gets the OsidSession associated with the publisher hierarchy service.
PublisherLookupSession	getPublisherLookupSession()	Gets the OsidSession associated with the publisher lookup service.
PublisherNotificationSession	getPublisherNotificationSession(PublisherReceiver publisherReceiver)	Gets the OsidSession associated with the publisher notification service.
PublisherQuerySession	getPublisherQuerySession()	Gets the OsidSession associated with the publisher query service.
PublisherSearchSession	getPublisherSearchSession()	Gets the OsidSession associated with the publisher search service.
SubscriptionAdminSession	getSubscriptionAdminSession()	Gets the OsidSession associated with the subscription administration service.
SubscriptionAdminSession	getSubscriptionAdminSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription administration service for the given publisher.
SubscriptionBatchManager	getSubscriptionBatchManager()	Gets the SubscriptionBatchManager .
SubscriptionLookupSession	getSubscriptionLookupSession()	Gets the OsidSession associated with the subscription lookup service.
SubscriptionLookupSession	getSubscriptionLookupSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription lookup service for the given publisher.
SubscriptionNotificationSession	getSubscriptionNotificationSession(SubscriptionReceiver subscriptionReceiver)	Gets the OsidSession associated with the subscription notification service.
SubscriptionNotificationSession	getSubscriptionNotificationSessionForPublisher(SubscriptionReceiver subscriptionReceiver, Id publisherId)	Gets the OsidSession associated with the subscription notification service for the given publisher.
SubscriptionPublisherAssignmentSession	getSubscriptionPublisherAssignmentSession()	Gets the session for assigning subscription to publisher mappings.
SubscriptionPublisherSession	getSubscriptionPublisherSession()	Gets the session for retrieving subscription to publisher mappings.
SubscriptionQuerySession	getSubscriptionQuerySession()	Gets the OsidSession associated with the subscription query service.
SubscriptionQuerySession	getSubscriptionQuerySessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription query service for the given publisher.
SubscriptionRulesManager	getSubscriptionRulesManager()	Gets the SubscriptionRulesManager .
SubscriptionSearchSession	getSubscriptionSearchSession()	Gets the OsidSession associated with the subscription search service.
SubscriptionSearchSession	getSubscriptionSearchSessionForPublisher(Id publisherId)	Gets the OsidSession associated with the subscription search service for the given publisher.
SubscriptionSmartPublisherSession	getSubscriptionSmartPublisherSession(Id publisherId)	Gets the session associated with the subscription smart publisher 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 SubscriptionProfile

getDispatchRecordTypes, getDispatchSearchRecordTypes, getPublisherRecordTypes, getPublisherSearchRecordTypes, getSubscriptionRecordTypes, getSubscriptionSearchRecordTypes, supportsDispatchAdmin, supportsDispatchLookup, supportsDispatchNotification, supportsDispatchPublisher, supportsDispatchPublisherAssignment, supportsDispatchQuery, supportsDispatchRecordType, supportsDispatchSearch, supportsDispatchSearchRecordType, supportsDispatchSmartPublisher, supportsMySubscription, supportsMySubscriptionAdmin, supportsPublisherAdmin, supportsPublisherHierarchy, supportsPublisherHierarchyDesign, supportsPublisherLookup, supportsPublisherNotification, supportsPublisherQuery, supportsPublisherRecordType, supportsPublisherSearch, supportsPublisherSearchRecordType, supportsSubscriptionAdmin, supportsSubscriptionBatch, supportsSubscriptionLookup, supportsSubscriptionNotification, supportsSubscriptionPublisher, supportsSubscriptionPublisherAssignment, supportsSubscriptionQuery, supportsSubscriptionRecordType, supportsSubscriptionRules, supportsSubscriptionSearch, supportsSubscriptionSearchRecordType, supportsSubscriptionSmartPublisher, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getDispatchRecordTypes()	Gets the supported Dispatch record types.
TypeList	getDispatchSearchRecordTypes()	Gets the supported dispatch search record types.
TypeList	getPublisherRecordTypes()	Gets the supported Publisher record types.
TypeList	getPublisherSearchRecordTypes()	Gets the supported publisher search record types.
TypeList	getSubscriptionRecordTypes()	Gets the supported Subscription record types.
TypeList	getSubscriptionSearchRecordTypes()	Gets the supported subscription search record types.
boolean	supportsDispatchAdmin()	Tests for the availability of a dispatch administrative service for creating and deleting dispatches.
boolean	supportsDispatchLookup()	Tests for the availability of a dispatch lookup service.
boolean	supportsDispatchNotification()	Tests for the availability of a dispatch notification service.
boolean	supportsDispatchPublisher()	Tests if a dispatch to publisher lookup session is available.
boolean	supportsDispatchPublisherAssignment()	Tests if a dispatch to publisher assignment session is available.
boolean	supportsDispatchQuery()	Tests if querying dispatches is available.
boolean	supportsDispatchRecordType(Type dispatchRecordType)	Tests if the given Dispatch record type is supported.
boolean	supportsDispatchSearch()	Tests if searching for dispatches is available.
boolean	supportsDispatchSearchRecordType(Type dispatchSearchRecordType)	Tests if the given dispatch search record type is supported.
boolean	supportsDispatchSmartPublisher()	Tests if a dispatch smart publisher session is available.
boolean	supportsMySubscription()	Tests for the availability of a my subscription lookup service.
boolean	supportsMySubscriptionAdmin()	Tests for the availability of a my subscription administrative service.
boolean	supportsPublisherAdmin()	Tests for the availability of a publisher administrative service for creating and deleting publishers.
boolean	supportsPublisherHierarchy()	Tests for the availability of a publisher hierarchy traversal service.
boolean	supportsPublisherHierarchyDesign()	Tests for the availability of a publisher hierarchy design service.
boolean	supportsPublisherLookup()	Tests for the availability of a publisher lookup service.
boolean	supportsPublisherNotification()	Tests for the availability of a publisher notification service.
boolean	supportsPublisherQuery()	Tests if querying publishers is available.
boolean	supportsPublisherRecordType(Type publisherRecordType)	Tests if the given Publisher record type is supported.
boolean	supportsPublisherSearch()	Tests if searching for publishers is available.
boolean	supportsPublisherSearchRecordType(Type publisherSearchRecordType)	Tests if the given publisher search record type is supported.
boolean	supportsSubscriptionAdmin()	Tests if searching for subscriptions is available.
boolean	supportsSubscriptionBatch()	Tests for the availability of a subscription batch service.
boolean	supportsSubscriptionLookup()	Tests for the availability of a subscription lookup service.
boolean	supportsSubscriptionNotification()	Tests if subscription notification is available.
boolean	supportsSubscriptionPublisher()	Tests if a subscription to publisher lookup session is available.
boolean	supportsSubscriptionPublisherAssignment()	Tests if a subscription to publisher assignment session is available.
boolean	supportsSubscriptionQuery()	Tests if querying subscriptions is available.
boolean	supportsSubscriptionRecordType(Type subscriptionRecordType)	Tests if the given Subscription record type is supported.
boolean	supportsSubscriptionRules()	Tests for the availability of a subscription rules service.
boolean	supportsSubscriptionSearch()	Tests if searching for subscriptions is available.
boolean	supportsSubscriptionSearchRecordType(Type subscriptionSearchRecordType)	Tests if the given subscription search record type is supported.
boolean	supportsSubscriptionSmartPublisher()	Tests if a subscription smart publisher session is available.
boolean	supportsVisibleFederation()	Tests if any dispatch federation is exposed.

Method Details

getMySubscriptionSession

MySubscriptionSession getMySubscriptionSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the subscription lookup service for the authenticated agent.

Returns:

a My S ubscriptionSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMySubscription() is false

Compliance:

optional - This method must be implemented if {@code supportsMySubscription()} is {@code true} .

getMySubscriptionSessionForPublisher

MySubscriptionSession getMySubscriptionSessionForPublisher(Id publisherId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription lookup service for the authenticated agent for the given publisher.

Parameters:

publisherId - the Id of the Publisher

Returns:

a MySubscriptionSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySubscription() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMySubscription()} and {@code supportsVisibleFederation()} are {@code true}

getMySubscriptionAdminSession

MySubscriptionAdminSession getMySubscriptionAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the subscription administrative service for the authenticated agent.

Returns:

a My S ubscriptionSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMySubscriptionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsMySubscriptionAdmin()} is {@code true} .

getMySubscriptionAdminSessionForPublisher

MySubscriptionAdminSession getMySubscriptionAdminSessionForPublisher(Id publisherId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription administrative service for the authenticated agent for the given publisher.

Parameters:

publisherId - the Id of the Publisher

Returns:

a MySubscriptionSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySubscriptionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMySubscriptionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionLookupSession

SubscriptionLookupSession getSubscriptionLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the subscription lookup service.

Returns:

a SubscriptionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionLookup()} is {@code true} .

getSubscriptionLookupSessionForPublisher

SubscriptionLookupSession getSubscriptionLookupSessionForPublisher(Id publisherId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription lookup service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionQuerySession

SubscriptionQuerySession getSubscriptionQuerySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the subscription query service.

Returns:

a SubscriptionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionQuery()} is {@code true} .

getSubscriptionQuerySessionForPublisher

SubscriptionQuerySession getSubscriptionQuerySessionForPublisher(Id publisherId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription query service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionQuerySession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionSearchSession

SubscriptionSearchSession getSubscriptionSearchSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the subscription search service.

Returns:

a SubscriptionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionSearch()} is {@code true} .

getSubscriptionSearchSessionForPublisher

SubscriptionSearchSession getSubscriptionSearchSessionForPublisher(Id publisherId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription search service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionSearchSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionAdminSession

SubscriptionAdminSession getSubscriptionAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the subscription administration service.

Returns:

a SubscriptionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionAdmin()} is {@code true} .

getSubscriptionAdminSessionForPublisher

SubscriptionAdminSession getSubscriptionAdminSessionForPublisher(Id publisherId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionNotificationSession

SubscriptionNotificationSession getSubscriptionNotificationSession(SubscriptionReceiver subscriptionReceiver)
                                                            throws OperationFailedException

Gets the OsidSession associated with the subscription notification service.

Parameters:

subscriptionReceiver - the receiver

Returns:

a SubscriptionNotificationSession

Throws:

NullArgumentException - subscriptionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionNotification()} is {@code true} .

getSubscriptionNotificationSessionForPublisher

SubscriptionNotificationSession getSubscriptionNotificationSessionForPublisher(SubscriptionReceiver subscriptionReceiver,
 Id publisherId)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subscription notification service for the given publisher.

Parameters:

subscriptionReceiver - the receiver

publisherId - the Id of the Publisher

Returns:

a SubscriptionNotificationSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - subscriptionReceiver or publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getSubscriptionPublisherSession

SubscriptionPublisherSession getSubscriptionPublisherSession()
                                                      throws OperationFailedException

Gets the session for retrieving subscription to publisher mappings.

Returns:

a SubscriptionPublisherSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionPublisher() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionPublisher()} is {@code true} .

getSubscriptionPublisherAssignmentSession

SubscriptionPublisherAssignmentSession getSubscriptionPublisherAssignmentSession()
                                                                          throws OperationFailedException

Gets the session for assigning subscription to publisher mappings.

Returns:

a SubscriptionPublisherAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionPublisherAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionPublisherAssignment()} is {@code true} .

getSubscriptionSmartPublisherSession

SubscriptionSmartPublisherSession getSubscriptionSmartPublisherSession(Id publisherId)
                                                                throws NotFoundException,
OperationFailedException

Gets the session associated with the subscription smart publisher for the given publisher.

Parameters:

publisherId - the Id of the publisher

Returns:

a SubscriptionSmartPublisherSession

Throws:

NotFoundException - publisherId not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionSmartPublisher() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionSmartPublisher()} is {@code true} .

getDispatchLookupSession

DispatchLookupSession getDispatchLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the dispatch lookup service.

Returns:

a DispatchLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchLookup()} is {@code true} .

getDispatchLookupSessionForPublisher

DispatchLookupSession getDispatchLookupSessionForPublisher(Id publisherId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the dispatch lookup service for the given publisher.

Parameters:

publisherId - the Id of the Dispatch

Returns:

a DispatchLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchLookup()} and {@code supportsVisibleFederation()} are {@code true}

getDispatchQuerySession

DispatchQuerySession getDispatchQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the dispatch query service.

Returns:

a DispatchQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchQuery()} is {@code true} .

getDispatchQuerySessionForPublisher

DispatchQuerySession getDispatchQuerySessionForPublisher(Id publisherId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the dispatch query service for the given publisher.

Parameters:

publisherId - the Id of the Dispatch

Returns:

a DispatchQuerySession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchQuery()} and {@code supportsVisibleFederation()} are {@code true}

getDispatchSearchSession

DispatchSearchSession getDispatchSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the dispatch search service.

Returns:

a DispatchSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchSearch()} is {@code true} .

getDispatchSearchSessionForPublisher

DispatchSearchSession getDispatchSearchSessionForPublisher(Id publisherId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the dispatch search service for the given publisher.

Parameters:

publisherId - the Id of the Dispatch

Returns:

a DispatchSearchSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchSearch()} and {@code supportsVisibleFederation()} are {@code true}

getDispatchAdminSession

DispatchAdminSession getDispatchAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the dispatch administrative service.

Returns:

a DispatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchAdmin()} is {@code true} .

getDispatchAdminSessionForPublisher

DispatchAdminSession getDispatchAdminSessionForPublisher(Id publisherId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the dispatch administrative service for the given publisher.

Parameters:

publisherId - the Id of the Dispatch

Returns:

a DispatchAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getDispatchNotificationSession

DispatchNotificationSession getDispatchNotificationSession(DispatchReceiver dispatchReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the dispatch notification service.

Parameters:

dispatchReceiver - the receiver

Returns:

a DispatchNotificationSession

Throws:

NullArgumentException - dispatchReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchNotification()} is {@code true} .

getDispatchNotificationSessionForPublisher

DispatchNotificationSession getDispatchNotificationSessionForPublisher(DispatchReceiver dispatchReceiver,
 Id publisherId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the dispatch notification service for the given publisher.

Parameters:

dispatchReceiver - the receiver

publisherId - the Id of the Publisher

Returns:

a DispatchNotificationSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - dispatchReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchNotification()} and {@code supportsVisibleFederation()} are {@code true}

getDispatchPublisherSession

DispatchPublisherSession getDispatchPublisherSession()
                                              throws OperationFailedException

Gets the session for retrieving dispatch to publisher mappings.

Returns:

a DispatchPublisherSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchPublisher() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchPublisher()} is {@code true} .

getDispatchPublisherAssignmentSession

DispatchPublisherAssignmentSession getDispatchPublisherAssignmentSession()
                                                                  throws OperationFailedException

Gets the session for assigning dispatch to publisher mappings.

Returns:

a DispatchPublisherAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchPublisherAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchPublisherAssignment()} is {@code true} .

getDispatchSmartPublisherSession

DispatchSmartPublisherSession getDispatchSmartPublisherSession(Id publisherId)
                                                        throws NotFoundException,
OperationFailedException

Gets the session associated with the dispatch smart publisher for the given publisher.

Parameters:

publisherId - the Id of the publisher

Returns:

a DispatchSmartPublisherSession

Throws:

NotFoundException - publisherId not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchSmartPublisher() is false

Compliance:

optional - This method must be implemented if {@code supportsDispatchSmartPublisher()} is {@code true} .

getPublisherLookupSession

PublisherLookupSession getPublisherLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the publisher lookup service.

Returns:

a PublisherLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherLookup()} is {@code true} .

getPublisherQuerySession

PublisherQuerySession getPublisherQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the publisher query service.

Returns:

a PublisherQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherQuery()} is {@code true} .

getPublisherSearchSession

PublisherSearchSession getPublisherSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the publisher search service.

Returns:

a PublisherSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherSearch()} is {@code true} .

getPublisherAdminSession

PublisherAdminSession getPublisherAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the publisher administrative service.

Returns:

a PublisherAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherAdmin()} is {@code true} .

getPublisherNotificationSession

PublisherNotificationSession getPublisherNotificationSession(PublisherReceiver publisherReceiver)
                                                      throws OperationFailedException

Gets the OsidSession associated with the publisher notification service.

Parameters:

publisherReceiver - the receiver

Returns:

a PublisherNotificationSession

Throws:

NullArgumentException - publisherReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherNotification()} is {@code true} .

getPublisherHierarchySession

PublisherHierarchySession getPublisherHierarchySession()
                                                throws OperationFailedException

Gets the OsidSession associated with the publisher hierarchy service.

Returns:

a PublisherHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherHierarchy()} is {@code true} .

getPublisherHierarchyDesignSession

PublisherHierarchyDesignSession getPublisherHierarchyDesignSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the publisher hierarchy design service.

Returns:

a PublisherHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsPublisherHierarchyDesign()} is {@code true} .

getSubscriptionBatchManager

SubscriptionBatchManager getSubscriptionBatchManager()
                                              throws OperationFailedException

Gets the SubscriptionBatchManager .

Returns:

a SubscriptionBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionbatch() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionbatch()} is {@code true} .

getSubscriptionRulesManager

SubscriptionRulesManager getSubscriptionRulesManager()
                                              throws OperationFailedException

Gets the SubscriptionRulesManager .

Returns:

a SubscriptionRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionRules() is false

Compliance:

optional - This method must be implemented if {@code supportsSubscriptionRules()} is {@code true} .