OSID - osid.subscription.SubscriptionManager Service Interface Definition

Interface	osid.subscription.SubscriptionManager
Implements	`osid.OsidManager`
Implements	`osid.subscription.SubscriptionProfile`
Description	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	getMySubscriptionSession
Description	Gets the `OsidSession` associated with the subscription lookup service for the authenticated agent.
Return	`osid.subscription.MySubscriptionSession`		a `My` S `ubscriptionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMySubscription()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMySubscription()` is `true.`
Method	getMySubscriptionSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription lookup service for the authenticated agent for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.MySubscriptionSession`		a `MySubscriptionSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription administrative service for the authenticated agent.
Return	`osid.subscription.MySubscriptionAdminSession`		a `My` S `ubscriptionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMySubscriptionAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMySubscriptionAdmin()` is `true.`
Method	getMySubscriptionAdminSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription administrative service for the authenticated agent for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.MySubscriptionAdminSession`		a `MySubscriptionSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription lookup service.
Return	`osid.subscription.SubscriptionLookupSession`		a `SubscriptionLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionLookup()` is `true.`
Method	getSubscriptionLookupSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription lookup service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.SubscriptionLookupSession`		a `SubscriptionLookupSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription query service.
Return	`osid.subscription.SubscriptionQuerySession`		a `SubscriptionQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionQuery()` is `true.`
Method	getSubscriptionQuerySessionForPublisher
Description	Gets the `OsidSession` associated with the subscription query service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.SubscriptionQuerySession`		a `SubscriptionQuerySession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription search service.
Return	`osid.subscription.SubscriptionSearchSession`		a `SubscriptionSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionSearch()` is `true.`
Method	getSubscriptionSearchSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription search service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.SubscriptionSearchSession`		a `SubscriptionSearchSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription administration service.
Return	`osid.subscription.SubscriptionAdminSession`		a `SubscriptionAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionAdmin()` is `true.`
Method	getSubscriptionAdminSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription administration service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.SubscriptionAdminSession`		a `SubscriptionAdminSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the subscription notification service.
Parameters	`osid.subscription.SubscriptionReceiver`	`subscriptionReceiver`	the receiver
Return	`osid.subscription.SubscriptionNotificationSession`		a `SubscriptionNotificationSession`
Errors	NULL_ARGUMENT		`subscriptionReceiver` 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 `OsidSession` associated with the subscription notification service for the given publisher.
Parameters	`osid.subscription.SubscriptionReceiver`	`subscriptionReceiver`	the receiver
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.SubscriptionNotificationSession`		a `SubscriptionNotificationSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`subscriptionReceiver` or `publisherId` 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.
Return	`osid.subscription.SubscriptionPublisherSession`		a `SubscriptionPublisherSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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.
Return	`osid.subscription.SubscriptionPublisherAssignmentSession`		a `SubscriptionPublisherAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.subscription.SubscriptionSmartPublisherSession`		a `SubscriptionSmartPublisherSession`
Errors	NOT_FOUND		`publisherId` not found
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the dispatch lookup service.
Return	`osid.subscription.DispatchLookupSession`		a `DispatchLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDispatchLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchLookup()` is `true.`
Method	getDispatchLookupSessionForPublisher
Description	Gets the `OsidSession` associated with the dispatch lookup service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Dispatch`
Return	`osid.subscription.DispatchLookupSession`		a `DispatchLookupSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the dispatch query service.
Return	`osid.subscription.DispatchQuerySession`		a `DispatchQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDispatchQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchQuery()` is `true.`
Method	getDispatchQuerySessionForPublisher
Description	Gets the `OsidSession` associated with the dispatch query service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Dispatch`
Return	`osid.subscription.DispatchQuerySession`		a `DispatchQuerySession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the dispatch search service.
Return	`osid.subscription.DispatchSearchSession`		a `DispatchSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDispatchSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchSearch()` is `true.`
Method	getDispatchSearchSessionForPublisher
Description	Gets the `OsidSession` associated with the dispatch search service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Dispatch`
Return	`osid.subscription.DispatchSearchSession`		a `DispatchSearchSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the dispatch administrative service.
Return	`osid.subscription.DispatchAdminSession`		a `DispatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDispatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchAdmin()` is `true.`
Method	getDispatchAdminSessionForPublisher
Description	Gets the `OsidSession` associated with the dispatch administrative service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Dispatch`
Return	`osid.subscription.DispatchAdminSession`		a `DispatchAdminSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the dispatch notification service.
Parameters	`osid.subscription.DispatchReceiver`	`dispatchReceiver`	the receiver
Return	`osid.subscription.DispatchNotificationSession`		a `DispatchNotificationSession`
Errors	NULL_ARGUMENT		`dispatchReceiver` 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 `OsidSession` associated with the dispatch notification service for the given publisher.
Parameters	`osid.subscription.DispatchReceiver`	`dispatchReceiver`	the receiver
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.DispatchNotificationSession`		a `DispatchNotificationSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`dispatchReceiver` 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.
Return	`osid.subscription.DispatchPublisherSession`		a `DispatchPublisherSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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.
Return	`osid.subscription.DispatchPublisherAssignmentSession`		a `DispatchPublisherAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDispatchPublisherAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchPublisherAssignment()` is `true.`
Method	getDispatchSmartPublisherSession
Description	Gets the session associated with the dispatch smart publisher for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the publisher
Return	`osid.subscription.DispatchSmartPublisherSession`		a `DispatchSmartPublisherSession`
Errors	NOT_FOUND		`publisherId` not found
	NULL_ARGUMENT		`publisherId` 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 `OsidSession` associated with the publisher lookup service.
Return	`osid.subscription.PublisherLookupSession`		a `PublisherLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherLookup()` is `true.`
Method	getPublisherQuerySession
Description	Gets the `OsidSession` associated with the publisher query service.
Return	`osid.subscription.PublisherQuerySession`		a `PublisherQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherQuery()` is `true.`
Method	getPublisherSearchSession
Description	Gets the `OsidSession` associated with the publisher search service.
Return	`osid.subscription.PublisherSearchSession`		a `PublisherSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherSearch()` is `true.`
Method	getPublisherAdminSession
Description	Gets the `OsidSession` associated with the publisher administrative service.
Return	`osid.subscription.PublisherAdminSession`		a `PublisherAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherAdmin()` is `true.`
Method	getPublisherNotificationSession
Description	Gets the `OsidSession` associated with the publisher notification service.
Parameters	`osid.subscription.PublisherReceiver`	`publisherReceiver`	the receiver
Return	`osid.subscription.PublisherNotificationSession`		a `PublisherNotificationSession`
Errors	NULL_ARGUMENT		`publisherReceiver` 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 `OsidSession` associated with the publisher hierarchy service.
Return	`osid.subscription.PublisherHierarchySession`		a `PublisherHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherHierarchy()` is `true.`
Method	getPublisherHierarchyDesignSession
Description	Gets the `OsidSession` associated with the publisher hierarchy design service.
Return	`osid.subscription.PublisherHierarchyDesignSession`		a `PublisherHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPublisherHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherHierarchyDesign()` is `true.`
Method	getSubscriptionBatchManager
Description	Gets the `SubscriptionBatchManager.`
Return	`osid.subscription.batch.SubscriptionBatchManager`		a `SubscriptionBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionbatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionbatch()` is `true.`
Method	getSubscriptionRulesManager
Description	Gets the `SubscriptionRulesManager.`
Return	`osid.subscription.rules.SubscriptionRulesManager`		a `SubscriptionRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionRules()` is `true.`