Interface | osid.subscription.SubscriptionProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.subscription.SubscriptionProfile | |||
Description |
The subscription manager provides access to subscription
sessions and provides interoperability tests for various
aspects of this service. Methods in this manager accept a
The subscription manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getMySubscriptionSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.MySubscriptionSession | a My S ubscriptionSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySubscription() is false | ||
Compliance | optional | This method must be implemented if supportsMySubscription()
is true. | |
Method | getMySubscriptionSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.MySubscriptionSession | a MySubscriptionSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySubscription() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsMySubscription()
and supportsVisibleFederation() are true | |
Method | getMySubscriptionAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.MySubscriptionAdminSession | a My S ubscriptionSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySubscriptionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsMySubscriptionAdmin()
is true. | |
Method | getMySubscriptionAdminSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.MySubscriptionAdminSession | a MySubscriptionSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySubscriptionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsMySubscriptionAdmin()
and supportsVisibleFederation() are true | |
Method | getSubscriptionLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionLookupSession | a SubscriptionLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionLookup()
is true. | |
Method | getSubscriptionLookupSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionLookupSession | a SubscriptionLookupSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionLookup()
and supportsVisibleFederation() are true | |
Method | getSubscriptionQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionQuerySession | a SubscriptionQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionQuery()
is true. | |
Method | getSubscriptionQuerySessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionQuerySession | a SubscriptionQuerySession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionQuery()
and supportsVisibleFederation() are true | |
Method | getSubscriptionSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionSearchSession | a SubscriptionSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionSearch()
is true. | |
Method | getSubscriptionSearchSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionSearchSession | a SubscriptionSearchSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | pubisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionSearch()
and supportsVisibleFederation() are true | |
Method | getSubscriptionAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionAdminSession | a SubscriptionAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionAdmin()
is true. | |
Method | getSubscriptionAdminSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionAdminSession | a SubscriptionAdminSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionAdmin()
and supportsVisibleFederation() are true | |
Method | getSubscriptionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.subscription.SubscriptionReceiver | subscriptionReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionNotificationSession | a SubscriptionNotificationSession | |
Errors | NULL_ARGUMENT | subscriptionReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsSubscriptionNotification() is true. | |
Method | getSubscriptionNotificationSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.subscription.SubscriptionReceiver | subscriptionReceiver | the receiver |
osid.id.Id | publisherId | the Id of the Publisher | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionNotificationSession | a SubscriptionNotificationSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | subscriptionReceiver, publisherId, or proxy
is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsSubscriptionNotification() and
supportsVisibleFederation() are true | |
Method | getSubscriptionPublisherSession | ||
Description |
Gets the session for retrieving subscription to publisher mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionPublisherSession | a SubscriptionPublisherSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionPublisher() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionPublisher()
is true. | |
Method | getSubscriptionPublisherAssignmentSession | ||
Description |
Gets the session for assigning subscription to publisher mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.SubscriptionPublisherAssignmentSession | a SubscriptionPublisherAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionPublisherAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsSubscriptionPublisherAssignment() is true. | |
Method | getSubscriptionSmartPublisherSession | ||
Description |
Gets the session associated with the subscription smart publisher for the given publisher. | ||
Parameters | osid.id.Id | publisherId | the Id of the publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.SubscriptionSmartPublisherSession | a SubscriptionSmartPublisherSession | |
Errors | NOT_FOUND | publisherId not found | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubscriptionSmartPublisher() is false | ||
Compliance | optional | This method must be implemented if
supportsSubscriptionSmartPublisher() is true. | |
Method | getDispatchLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchLookupSession | a DispatchLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchLookup()
is true. | |
Method | getDispatchLookupSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchLookupSession | a DispatchLookupSession | |
Errors | NOT_FOUND | no Publisher found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchLookup()
and supportsVisibleFederation() are true | |
Method | getDispatchQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchQuerySession | a DispatchQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchQuery()
is true. | |
Method | getDispatchQuerySessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchQuerySession | a DispatchQuerySession | |
Errors | NOT_FOUND | no Dispatch found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchQuery()
and supportsVisibleFederation() are true | |
Method | getDispatchSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchSearchSession | a DispatchSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchSearch()
is true. | |
Method | getDispatchSearchSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchSearchSession | a DispatchSearchSession | |
Errors | NOT_FOUND | no Dispatch found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchSearch()
and supportsVisibleFederation() are true | |
Method | getDispatchAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchAdminSession | a DispatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchAdmin()
is true. | |
Method | getDispatchAdminSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchAdminSession | a DispatchAdminSession | |
Errors | NOT_FOUND | no Dispatch found by the given Id | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchAdmin()
and supportsVisibleFederation() are true | |
Method | getDispatchNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.subscription.DispatchReceiver | dispatchReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchNotificationSession | a DispatchNotificationSession | |
Errors | NULL_ARGUMENT | dispatchReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchNotification()
is true. | |
Method | getDispatchNotificationSessionForPublisher | ||
Description |
Gets the | ||
Parameters | osid.subscription.DispatchReceiver | dispatchReceiver | the receiver |
osid.id.Id | publisherId | the Id of the Publisher | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchNotificationSession | a DispatchNotificationSession | |
Errors | NOT_FOUND | no Dispatch found by the given Id | |
NULL_ARGUMENT | dispatchReceiver, publisherId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchNotification()
and supportsVisibleFederation() are true | |
Method | getDispatchPublisherSession | ||
Description |
Gets the session for retrieving dispatch to publisher mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchPublisherSession | a DispatchPublisherSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchPublisher() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchPublisher()
is true. | |
Method | getDispatchPublisherAssignmentSession | ||
Description |
Gets the session for assigning dispatch to publisher mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.DispatchPublisherAssignmentSession | a DispatchPublisherAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchPublisherAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsDispatchPublisherAssignment() is true. | |
Method | getDispatchSmartPublisherSession | ||
Description |
Gets the session for managing dynamic dispatch publishers for the given publisher. | ||
Parameters | osid.id.Id | publisherId | the Id of a publisher |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.DispatchSmartPublisherSession | a DispatchSmartPublisherSession | |
Errors | NOT_FOUND | publisherId not found | |
NULL_ARGUMENT | publisherId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDispatchSmartPublisher() is false | ||
Compliance | optional | This method must be implemented if supportsDispatchSmartPublisher()
is true. | |
Method | getPublisherLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherLookupSession | a PublisherLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherLookup()
is true. | |
Method | getPublisherQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherQuerySession | a PublisherQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherQuery()
is true. | |
Method | getPublisherSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherSearchSession | a PublisherSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherSearch()
is true. | |
Method | getPublisherAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherAdminSession | a PublisherAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherAdmin()
is true. | |
Method | getPublisherNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.subscription.PublisherReceiver | publisherReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.subscription.PublisherNotificationSession | a PublisherNotificationSession | |
Errors | NULL_ARGUMENT | publisherReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherNotification()
is true. | |
Method | getPublisherHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherHierarchySession | a PublisherHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsPublisherHierarchy()
is true. | |
Method | getPublisherHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.subscription.PublisherHierarchyDesignSession | a PublisherHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPublisherHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsPublisherHierarchyDesign() is true. | |
Method | getSubscriptionBatchProxyManager | ||
Description |
Gets the | ||
Return | osid.subscription.batch.SubscriptionBatchProxyManager | a SubscriptionBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubscriptionRules() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionRules()
is true. | |
Method | getSubscriptionRulesProxyManager | ||
Description |
Gets the | ||
Return | osid.subscription.rules.SubscriptionRulesProxyManager | a SubscriptionRulesProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubscriptionRules() is false | ||
Compliance | optional | This method must be implemented if supportsSubscriptionRules()
is true. |