org.osid.subscription

Interface SubscriptionProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, SubscriptionProfile

public interface SubscriptionProxyManager
extends OsidProxyManager, SubscriptionProfile

The subscription manager provides access to subscription sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the dispatch administrative service.
DispatchAdminSession	getDispatchAdminSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the dispatch administration service for the given publisher.
DispatchLookupSession	getDispatchLookupSession(Proxy proxy) Gets the OsidSession associated with the dispatch lookup service.
DispatchLookupSession	getDispatchLookupSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the dispatch lookup service for the given publisher.
DispatchNotificationSession	getDispatchNotificationSession(DispatchReceiver dispatchReceiver, Proxy proxy) Gets the OsidSession associated with the dispatch notification service.
DispatchNotificationSession	getDispatchNotificationSessionForPublisher(DispatchReceiver dispatchReceiver, Id publisherId, Proxy proxy) Gets the OsidSession associated with the dispatch notification service for the given publisher.
DispatchPublisherAssignmentSession	getDispatchPublisherAssignmentSession(Proxy proxy) Gets the session for assigning dispatch to publisher mappings.
DispatchPublisherSession	getDispatchPublisherSession(Proxy proxy) Gets the session for retrieving dispatch to publisher mappings.
DispatchQuerySession	getDispatchQuerySession(Proxy proxy) Gets the OsidSession associated with the dispatch query service.
DispatchQuerySession	getDispatchQuerySessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the dispatch query service for the given publisher.
DispatchSearchSession	getDispatchSearchSession(Proxy proxy) Gets the OsidSession associated with the dispatch search service.
DispatchSearchSession	getDispatchSearchSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the dispatch search service for the given publisher.
DispatchSmartPublisherSession	getDispatchSmartPublisherSession(Id publisherId, Proxy proxy) Gets the session for managing dynamic dispatch publishers for the given publisher.
MySubscriptionAdminSession	getMySubscriptionAdminSession(Proxy proxy) Gets the OsidSession associated with the subscription administrative service for the authenticated agent.
MySubscriptionAdminSession	getMySubscriptionAdminSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription administrative service for the authenticated agent for the given publisher.
MySubscriptionSession	getMySubscriptionSession(Proxy proxy) Gets the OsidSession associated with the subscription lookup service for the authenticated agent.
MySubscriptionSession	getMySubscriptionSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription lookup service for the authenticated agent for the given publisher.
PublisherAdminSession	getPublisherAdminSession(Proxy proxy) Gets the OsidSession associated with the publisher administrative service.
PublisherHierarchyDesignSession	getPublisherHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the publisher hierarchy design service.
PublisherHierarchySession	getPublisherHierarchySession(Proxy proxy) Gets the OsidSession associated with the publisher hierarchy service.
PublisherLookupSession	getPublisherLookupSession(Proxy proxy) Gets the OsidSession associated with the publisher lookup service.
PublisherNotificationSession	getPublisherNotificationSession(PublisherReceiver publisherReceiver, Proxy proxy) Gets the OsidSession associated with the publisher notification service.
PublisherQuerySession	getPublisherQuerySession(Proxy proxy) Gets the OsidSession associated with the publisher query service.
PublisherSearchSession	getPublisherSearchSession(Proxy proxy) Gets the OsidSession associated with the publisher search service.
SubscriptionAdminSession	getSubscriptionAdminSession(Proxy proxy) Gets the OsidSession associated with the subscription administration service.
SubscriptionAdminSession	getSubscriptionAdminSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription administration service for the given publisher.
SubscriptionBatchProxyManager	getSubscriptionBatchProxyManager() Gets the SubscriptionBatchProxyManager.
SubscriptionLookupSession	getSubscriptionLookupSession(Proxy proxy) Gets the OsidSession associated with the subscription lookup service.
SubscriptionLookupSession	getSubscriptionLookupSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription lookup service for the given publisher.
SubscriptionNotificationSession	getSubscriptionNotificationSession(SubscriptionReceiver subscriptionReceiver, Proxy proxy) Gets the OsidSession associated with the subscription notification service.
SubscriptionNotificationSession	getSubscriptionNotificationSessionForPublisher(SubscriptionReceiver subscriptionReceiver, Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription notification service for the given publisher.
SubscriptionPublisherAssignmentSession	getSubscriptionPublisherAssignmentSession(Proxy proxy) Gets the session for assigning subscription to publisher mappings.
SubscriptionPublisherSession	getSubscriptionPublisherSession(Proxy proxy) Gets the session for retrieving subscription to publisher mappings.
SubscriptionQuerySession	getSubscriptionQuerySession(Proxy proxy) Gets the OsidSession associated with the subscription query service.
SubscriptionQuerySession	getSubscriptionQuerySessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription query service for the given publisher.
SubscriptionRulesProxyManager	getSubscriptionRulesProxyManager() Gets the SubscriptionRulesProxyManager.
SubscriptionSearchSession	getSubscriptionSearchSession(Proxy proxy) Gets the OsidSession associated with the subscription search service.
SubscriptionSearchSession	getSubscriptionSearchSessionForPublisher(Id publisherId, Proxy proxy) Gets the OsidSession associated with the subscription search service for the given publisher.
SubscriptionSmartPublisherSession	getSubscriptionSmartPublisherSession(Id publisherId, Proxy proxy) Gets the session associated with the subscription smart publisher for the given publisher.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                               throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a My S ubscriptionSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           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

proxy - a proxy

Returns:

a MySubscriptionSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a My S ubscriptionSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     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

proxy - a proxy

Returns:

a MySubscriptionSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the subscription lookup service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription query service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionQuerySession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the subscription search service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionSearchSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - pubisherId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription administration service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the subscription notification service.

Parameters:

subscriptionReceiver - the receiver

proxy - a proxy

Returns:

a SubscriptionNotificationSession

Throws:

NullArgumentException - subscriptionReceiver or proxy 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,
                                                                             Proxy proxy)
                                                                               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

proxy - a proxy

Returns:

a SubscriptionNotificationSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - subscriptionReceiver, publisherId, or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for retrieving subscription to publisher mappings.

Parameters:

proxy - a proxy

Returns:

a SubscriptionPublisherSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionPublisher() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionPublisher() is true.

getSubscriptionPublisherAssignmentSession

SubscriptionPublisherAssignmentSession getSubscriptionPublisherAssignmentSession(Proxy proxy)
                                                                                 throws OperationFailedException

Gets the session for assigning subscription to publisher mappings.

Parameters:

proxy - a proxy

Returns:

a SubscriptionPublisherAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

publisherId - the Id of the publisher

proxy - a proxy

Returns:

a SubscriptionSmartPublisherSession

Throws:

NotFoundException - publisherId not found

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the dispatch lookup service.

Parameters:

proxy - a proxy

Returns:

a DispatchLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a DispatchLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the dispatch query service.

Parameters:

proxy - a proxy

Returns:

a DispatchQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a DispatchQuerySession

Throws:

NotFoundException - no Dispatch found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the dispatch search service.

Parameters:

proxy - a proxy

Returns:

a DispatchSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a DispatchSearchSession

Throws:

NotFoundException - no Dispatch found by the given Id

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the dispatch administrative service.

Parameters:

proxy - a proxy

Returns:

a DispatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a DispatchAdminSession

Throws:

NotFoundException - no Dispatch found by the given Id

NullArgumentException - publisherId or proxy 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,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the dispatch notification service.

Parameters:

dispatchReceiver - the receiver

proxy - a proxy

Returns:

a DispatchNotificationSession

Throws:

NullArgumentException - dispatchReceiver or proxy 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,
                                                                     Proxy proxy)
                                                                       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

proxy - a proxy

Returns:

a DispatchNotificationSession

Throws:

NotFoundException - no Dispatch found by the given Id

NullArgumentException - dispatchReceiver, publisherId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the session for retrieving dispatch to publisher mappings.

Parameters:

proxy - a proxy

Returns:

a DispatchPublisherSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDispatchPublisher() is false

Compliance:

optional - This method must be implemented if supportsDispatchPublisher() is true.

getDispatchPublisherAssignmentSession

DispatchPublisherAssignmentSession getDispatchPublisherAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the session for assigning dispatch to publisher mappings.

Parameters:

proxy - a proxy

Returns:

a DispatchPublisherAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the session for managing dynamic dispatch publishers for the given publisher.

Parameters:

publisherId - the Id of a publisher

proxy - a proxy

Returns:

a DispatchSmartPublisherSession

Throws:

NotFoundException - publisherId not found

NullArgumentException - publisherId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the publisher lookup service.

Parameters:

proxy - a proxy

Returns:

a PublisherLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherLookup() is false

Compliance:

optional - This method must be implemented if supportsPublisherLookup() is true.

getPublisherQuerySession

PublisherQuerySession getPublisherQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the publisher query service.

Parameters:

proxy - a proxy

Returns:

a PublisherQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherQuery() is false

Compliance:

optional - This method must be implemented if supportsPublisherQuery() is true.

getPublisherSearchSession

PublisherSearchSession getPublisherSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the publisher search service.

Parameters:

proxy - a proxy

Returns:

a PublisherSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherSearch() is false

Compliance:

optional - This method must be implemented if supportsPublisherSearch() is true.

getPublisherAdminSession

PublisherAdminSession getPublisherAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the publisher administrative service.

Parameters:

proxy - a proxy

Returns:

a PublisherAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the publisher notification service.

Parameters:

publisherReceiver - the receiver

proxy - a proxy

Returns:

a PublisherNotificationSession

Throws:

NullArgumentException - publisherReceiver or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the publisher hierarchy service.

Parameters:

proxy - a proxy

Returns:

a PublisherHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherHierarchy() is false

Compliance:

optional - This method must be implemented if supportsPublisherHierarchy() is true.

getPublisherHierarchyDesignSession

PublisherHierarchyDesignSession getPublisherHierarchyDesignSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the publisher hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a PublisherHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPublisherHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsPublisherHierarchyDesign() is true.

getSubscriptionBatchProxyManager

SubscriptionBatchProxyManager getSubscriptionBatchProxyManager()
                                                               throws OperationFailedException

Gets the SubscriptionBatchProxyManager.

Returns:

a SubscriptionBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionRules() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionRules() is true.

getSubscriptionRulesProxyManager

SubscriptionRulesProxyManager getSubscriptionRulesProxyManager()
                                                               throws OperationFailedException

Gets the SubscriptionRulesProxyManager.

Returns:

a SubscriptionRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionRules() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionRules() is true.