org.osid.subscription

Interface SubscriptionManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.subscription.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

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

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 supportsMySubscription() is 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 supportsMySubscription() and supportsVisibleFederation() are 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 supportsMySubscriptionAdmin() is 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 supportsMySubscriptionAdmin() and supportsVisibleFederation() are 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 supportsSubscriptionLookup() is 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 supportsSubscriptionLookup() and supportsVisibleFederation() are 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 supportsSubscriptionQuery() is 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 supportsSubscriptionQuery() and supportsVisibleFederation() are 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 supportsSubscriptionSearch() is 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 supportsSubscriptionSearch() and supportsVisibleFederation() are 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 supportsSubscriptionAdmin() is 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 supportsSubscriptionAdmin() and supportsVisibleFederation() are 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 supportsSubscriptionNotification() is 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 supportsSubscriptionNotification() and supportsVisibleFederation() are 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 supportsSubscriptionPublisher() is 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 supportsSubscriptionPublisherAssignment() is 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 supportsSubscriptionSmartPublisher() is 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 supportsDispatchLookup() is 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 supportsDispatchLookup() and supportsVisibleFederation() are 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 supportsDispatchQuery() is 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 supportsDispatchQuery() and supportsVisibleFederation() are 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 supportsDispatchSearch() is 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 supportsDispatchSearch() and supportsVisibleFederation() are 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 supportsDispatchAdmin() is 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 supportsDispatchAdmin() and supportsVisibleFederation() are 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 supportsDispatchNotification() is 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 supportsDispatchNotification() and supportsVisibleFederation() are 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 supportsDispatchPublisher() is 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 supportsDispatchPublisherAssignment() is 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 supportsDispatchSmartPublisher() is 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 supportsPublisherLookup() is 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 supportsPublisherQuery() is 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 supportsPublisherSearch() is 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 supportsPublisherAdmin() is 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 supportsPublisherNotification() is 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 supportsPublisherHierarchy() is 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 supportsPublisherHierarchyDesign() is 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 supportsSubscriptionbatch() is 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 supportsSubscriptionRules() is true.