OSID - osid.subscription.rules.SubscriptionRulesManager Service Interface Definition

Interface	osid.subscription.rules.SubscriptionRulesManager
Implements	`osid.OsidManager`
Implements	`osid.subscription.rules.SubscriptionRulesProfile`
Description	The subscription rules manager provides access to subscription rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `SubscriptionEnablerLookupSession:` a session to retrieve subscription enablers `SubscriptionEnablerQuerySession:` a session to query for subscription enablers `SubscriptionEnablerSearchSession:` a session to search for subscription enablers `SubscriptionEnablerAdminSession:` a session to create and delete subscription enablers `SubscriptionEnablerNotificationSession:` a session to receive notifications pertaining to subscription enabler changes `SubscriptionEnablerPublisherSession:` a session to look up subscription enabler publisher mappings `SubscriptionEnablerPublisherAssignmentSession:` a session to manage subscription enabler to publisher mappings `SubscriptionEnablerSmartPublisherSession:` a session to manage dynamic publishers of subscription enablers `SubscriptionEnablerRuleLookupSession:` a session to look up subscription enabler to subscription mappings `SubscriptionEnablerRuleApplicationSession:` a session to apply subscription enablers to subscriptions
Method	getSubscriptionEnablerLookupSession
Description	Gets the `OsidSession` associated with the subscription enabler lookup service.
Return	`osid.subscription.rules.SubscriptionEnablerLookupSession`		a `SubscriptionEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerLookup()` is `true.`
Method	getSubscriptionEnablerLookupSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler lookup service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerLookupSession`		a `SubscriptionEnablerLookupSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerQuerySession
Description	Gets the `OsidSession` associated with the subscription enabler query service.
Return	`osid.subscription.rules.SubscriptionEnablerQuerySession`		a `SubscriptionEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerQuery()` is `true.`
Method	getSubscriptionEnablerQuerySessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler query service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerQuerySession`		a `SubscriptionEnablerQuerySession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerSearchSession
Description	Gets the `OsidSession` associated with the subscription enabler search service.
Return	`osid.subscription.rules.SubscriptionEnablerSearchSession`		a `SubscriptionEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerSearch()` is `true.`
Method	getSubscriptionEnablerSearchSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enablers earch service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerSearchSession`		a `SubscriptionEnablerSearchSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerAdminSession
Description	Gets the `OsidSession` associated with the subscription enabler administration service.
Return	`osid.subscription.rules.SubscriptionEnablerAdminSession`		a `SubscriptionEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerAdmin()` is `true.`
Method	getSubscriptionEnablerAdminSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler administration service for the given publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerAdminSession`		a `SubscriptionEnablerAdminSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerNotificationSession
Description	Gets the `OsidSession` associated with the subscription enabler notification service.
Parameters	`osid.subscription.rules.SubscriptionEnablerReceiver`	`subscriptionEnablerReceiver`	the notification callback
Return	`osid.subscription.rules.SubscriptionEnablerNotificationSession`		a `SubscriptionEnablerNotificationSession`
Errors	NULL_ARGUMENT		`subscriptionEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerNotification()` is `true.`
Method	getSubscriptionEnablerNotificationSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler notification service for the given publisher.
Parameters	`osid.subscription.rules.SubscriptionEnablerReceiver`	`subscriptionEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerNotificationSession`		a `SubscriptionEnablerNotificationSession`
Errors	NOT_FOUND		no publisher found by the given `Id`
	NULL_ARGUMENT		`subscriptionEnablerReceiver` or `publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerPublisherSession
Description	Gets the `OsidSession` to lookup subscription enablerpublisher mappings.
Return	`osid.subscription.rules.SubscriptionEnablerPublisherSession`		a `SubscriptionEnablerPublisherSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerPublisher()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerPublisher()` is `true.`
Method	getSubscriptionEnablerPublisherAssignmentSession
Description	Gets the `OsidSession` associated with assigning subscription enablers to publishers.
Return	`osid.subscription.rules.SubscriptionEnablerPublisherAssignmentSession`		a `SubscriptionEnablerPublisherAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerPublisherAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerPublisherAssignment()` is `true.`
Method	getSubscriptionEnablerSmartPublisherSession
Description	Gets the `OsidSession` to manage subscription enabler smart publishers.
Parameters	`osid.id.Id`	`publisherId`	the Id of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerSmartPublisherSession`		a `SubscriptionEnablerSmartPublisherSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerSmartPublisher()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerSmartPublisher()` is `true.`
Method	getSubscriptionEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the subscription enabler mapping lookup service for looking up the rules applied to the subscription.
Return	`osid.subscription.rules.SubscriptionEnablerRuleLookupSession`		a `SubscriptionEnablerRuleSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerRuleLookup()` is `true.`
Method	getSubscriptionEnablerRuleLookupSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler mapping lookup service for the given subscription for looking up rules applied to a subscription.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerRuleLookupSession`		a `SubscriptionEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getSubscriptionEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the subscription enabler assignment service to apply enablers to subscriptions.
Return	`osid.subscription.rules.SubscriptionEnablerRuleApplicationSession`		a `SubscriptionEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSubscriptionEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerRuleApplication()` is `true.`
Method	getSubscriptionEnablerRuleApplicationSessionForPublisher
Description	Gets the `OsidSession` associated with the subscription enabler assignment service for the given subscription to apply enablers to subscriptions.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.rules.SubscriptionEnablerRuleApplicationSession`		a `SubscriptionEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Publisher` found by the given `Id`
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSubscriptionEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`