OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionProxyManager
Implementsosid.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 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.

MethodgetMySubscriptionSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.MySubscriptionSessiona My S ubscriptionSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySubscription() is false
ComplianceoptionalThis method must be implemented if supportsMySubscription() is true.
MethodgetMySubscriptionSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.MySubscriptionSessiona MySubscriptionSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySubscription() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMySubscription() and supportsVisibleFederation() are true
MethodgetMySubscriptionAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.MySubscriptionAdminSessiona My S ubscriptionSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySubscriptionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsMySubscriptionAdmin() is true.
MethodgetMySubscriptionAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.MySubscriptionAdminSessiona MySubscriptionSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySubscriptionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMySubscriptionAdmin() and supportsVisibleFederation() are true
MethodgetSubscriptionLookupSession
Description

Gets the OsidSession associated with the subscription lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionLookupSessiona SubscriptionLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionLookup() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionLookup() is true.
MethodgetSubscriptionLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionLookupSessiona SubscriptionLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionLookup() and supportsVisibleFederation() are true
MethodgetSubscriptionQuerySession
Description

Gets the OsidSession associated with the subscription query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionQuerySessiona SubscriptionQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionQuery() is true.
MethodgetSubscriptionQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionQuerySessiona SubscriptionQuerySession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionQuery() and supportsVisibleFederation() are true
MethodgetSubscriptionSearchSession
Description

Gets the OsidSession associated with the subscription search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionSearchSessiona SubscriptionSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionSearch() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionSearch() is true.
MethodgetSubscriptionSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionSearchSessiona SubscriptionSearchSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT pubisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionSearch() and supportsVisibleFederation() are true
MethodgetSubscriptionAdminSession
Description

Gets the OsidSession associated with the subscription administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionAdminSessiona SubscriptionAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionAdmin() is true.
MethodgetSubscriptionAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionAdminSessiona SubscriptionAdminSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionAdmin() and supportsVisibleFederation() are true
MethodgetSubscriptionNotificationSession
Description

Gets the OsidSession associated with the subscription notification service.

Parametersosid.subscription.SubscriptionReceiversubscriptionReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionNotificationSessiona SubscriptionNotificationSession
ErrorsNULL_ARGUMENT subscriptionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionNotification() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionNotification() is true.
MethodgetSubscriptionNotificationSessionForPublisher
Description

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

Parametersosid.subscription.SubscriptionReceiversubscriptionReceiverthe receiver
osid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionNotificationSessiona SubscriptionNotificationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT subscriptionReceiver, publisherId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionNotification() and supportsVisibleFederation() are true
MethodgetSubscriptionPublisherSession
Description

Gets the session for retrieving subscription to publisher mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionPublisherSessiona SubscriptionPublisherSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionPublisher() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionPublisher() is true.
MethodgetSubscriptionPublisherAssignmentSession
Description

Gets the session for assigning subscription to publisher mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionPublisherAssignmentSessiona SubscriptionPublisherAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionPublisherAssignment() is true.
MethodgetSubscriptionSmartPublisherSession
Description

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

Parametersosid.id.IdpublisherIdthe Id of the publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.SubscriptionSmartPublisherSessiona SubscriptionSmartPublisherSession
ErrorsNOT_FOUND publisherId not found
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionSmartPublisher() is true.
MethodgetDispatchLookupSession
Description

Gets the OsidSession associated with the dispatch lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchLookupSessiona DispatchLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchLookup() is true.
MethodgetDispatchLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchLookupSessiona DispatchLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchLookup() and supportsVisibleFederation() are true
MethodgetDispatchQuerySession
Description

Gets the OsidSession associated with the dispatch query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchQuerySessiona DispatchQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchQuery() is true.
MethodgetDispatchQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchQuerySessiona DispatchQuerySession
ErrorsNOT_FOUNDno Dispatch found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchQuery() and supportsVisibleFederation() are true
MethodgetDispatchSearchSession
Description

Gets the OsidSession associated with the dispatch search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchSearchSessiona DispatchSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchSearch() is true.
MethodgetDispatchSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchSearchSessiona DispatchSearchSession
ErrorsNOT_FOUNDno Dispatch found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchSearch() and supportsVisibleFederation() are true
MethodgetDispatchAdminSession
Description

Gets the OsidSession associated with the dispatch administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchAdminSessiona DispatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchAdmin() is true.
MethodgetDispatchAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchAdminSessiona DispatchAdminSession
ErrorsNOT_FOUNDno Dispatch found by the given Id
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchAdmin() and supportsVisibleFederation() are true
MethodgetDispatchNotificationSession
Description

Gets the OsidSession associated with the dispatch notification service.

Parametersosid.subscription.DispatchReceiverdispatchReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchNotificationSessiona DispatchNotificationSession
ErrorsNULL_ARGUMENT dispatchReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchNotification() is true.
MethodgetDispatchNotificationSessionForPublisher
Description

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

Parametersosid.subscription.DispatchReceiverdispatchReceiverthe receiver
osid.id.IdpublisherIdthe Id of the Publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchNotificationSessiona DispatchNotificationSession
ErrorsNOT_FOUNDno Dispatch found by the given Id
NULL_ARGUMENT dispatchReceiver, publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchNotification() and supportsVisibleFederation() are true
MethodgetDispatchPublisherSession
Description

Gets the session for retrieving dispatch to publisher mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchPublisherSessiona DispatchPublisherSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchPublisher() is true.
MethodgetDispatchPublisherAssignmentSession
Description

Gets the session for assigning dispatch to publisher mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchPublisherAssignmentSessiona DispatchPublisherAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchPublisherAssignment() is true.
MethodgetDispatchSmartPublisherSession
Description

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

Parametersosid.id.IdpublisherIdthe Id of a publisher
osid.proxy.Proxyproxya proxy
Returnosid.subscription.DispatchSmartPublisherSessiona DispatchSmartPublisherSession
ErrorsNOT_FOUND publisherId not found
NULL_ARGUMENT publisherId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDispatchSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchSmartPublisher() is true.
MethodgetPublisherLookupSession
Description

Gets the OsidSession associated with the publisher lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherLookupSessiona PublisherLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherLookup() is false
ComplianceoptionalThis method must be implemented if supportsPublisherLookup() is true.
MethodgetPublisherQuerySession
Description

Gets the OsidSession associated with the publisher query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherQuerySessiona PublisherQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherQuery() is false
ComplianceoptionalThis method must be implemented if supportsPublisherQuery() is true.
MethodgetPublisherSearchSession
Description

Gets the OsidSession associated with the publisher search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherSearchSessiona PublisherSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherSearch() is false
ComplianceoptionalThis method must be implemented if supportsPublisherSearch() is true.
MethodgetPublisherAdminSession
Description

Gets the OsidSession associated with the publisher administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherAdminSessiona PublisherAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPublisherAdmin() is true.
MethodgetPublisherNotificationSession
Description

Gets the OsidSession associated with the publisher notification service.

Parametersosid.subscription.PublisherReceiverpublisherReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherNotificationSessiona PublisherNotificationSession
ErrorsNULL_ARGUMENT publisherReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherNotification() is false
ComplianceoptionalThis method must be implemented if supportsPublisherNotification() is true.
MethodgetPublisherHierarchySession
Description

Gets the OsidSession associated with the publisher hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherHierarchySessiona PublisherHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsPublisherHierarchy() is true.
MethodgetPublisherHierarchyDesignSession
Description

Gets the OsidSession associated with the publisher hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.subscription.PublisherHierarchyDesignSessiona PublisherHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPublisherHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsPublisherHierarchyDesign() is true.
MethodgetSubscriptionBatchProxyManager
Description

Gets the SubscriptionBatchProxyManager.

Returnosid.subscription.batch.SubscriptionBatchProxyManagera SubscriptionBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionRules() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionRules() is true.
MethodgetSubscriptionRulesProxyManager
Description

Gets the SubscriptionRulesProxyManager.

Returnosid.subscription.rules.SubscriptionRulesProxyManagera SubscriptionRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubscriptionRules() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionRules() is true.