OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.SubscriptionRulesManager
Implementsosid.OsidManager
osid.subscription.rules.SubscriptionRulesProfile
Used Byosid.subscription.SubscriptionManager
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:

  • DispatchEnablerLookupSession : a session to retrieve dispatch enablers
  • DispatchEnablerQuerySession : a session to query for dispatch enablers
  • DispatchEnablerSearchSession : a session to search for dispatch enablers
  • DispatchEnablerAdminSession : a session to create and delete dispatch enablers
  • DispatchEnablerNotificationSession : a session to receive notifications pertaining to dispatch enabler changes
  • DispatchEnablerPublisherSession : a session to look up dispatch enabler publisher mappings
  • DispatchEnablerPublisherAssignmentSession : a session to manage dispatch enabler to publisher mappings
  • DispatchEnablerSmartPublisherSession : a session to manage dynamic publishers of dispatch enablers
  • DispatchEnablerRuleLookupSession : a session to look up dispatch enablers to dispatch mappings
  • DispatchEnablerRuleApplicationSession : a session to apply dispatch enablers to dispatches
  • DispatchConstrainerLookupSession : a session to retrieve dispatch constrainers
  • DispatchConstrainerQuerySession : a session to query for dispatch constrainers
  • DispatchConstrainerSearchSession : a session to search for dispatch constrainers
  • DispatchConstrainerAdminSession : a session to create and delete dispatch constrainers
  • DispatchConstrainerNotificationSession : a session to receive notifications pertaining to dispatch constrainer changes
  • DispatchConstrainerPublisherSession : a session to look up dispatch constrainer publisher mappings
  • DispatchConstrainerPublisherAssignmentSession : a session to manage dispatch constrainer to publisher mappings
  • DispatchConstrainerSmartPublisherSession : a session to manage dynamic publishers of dispatch constrainers
  • DispatchConstrainerRuleLookupSession : a session to look up dispatch constrainers to dispatch mappings
  • DispatchConstrainerRuleApplicationSession : a session to apply dispatch constrainers to dispatches
  • DispatchConstrainerEnablerLookupSession : a session to retrieve dispatch constrainer enablers
  • DispatchConstrainerEnablerQuerySession : a session to query for dispatch constrainer enablers
  • DispatchConstrainerEnablerSearchSession : a session to search for dispatch constrainer enablers
  • DispatchConstrainerEnablerAdminSession : a session to create and delete dispatch constrainer enablers
  • DispatchConstrainerEnablerNotificationSession : a session to receive notifications pertaining to dispatch constrainer enabler changes
  • DispatchConstrainerEnablerPublisherSession : a session to look up dispatch constrainer enabler publisher mappings
  • DispatchConstrainerEnablerPublisherAssignmentSession : a session to manage dispatch constrainer enabler to publisher mappings
  • DispatchConstrainerEnablerSmartPublisherSession : a session to manage dynamic publishers of dispatch constrainer enablers
  • DispatchConstrainerEnablerRuleLookupSession : a session to look up dispatch constrainer enablers to dispatch constrainer mappings
  • DispatchConstrainerEnablerRuleApplicationSession : a session to apply dispatch constrainer enablers to dispatch constrainers
  • DispatchProcessorLookupSession : a session to retrieve dispatch processors
  • DispatchProcessorQuerySession : a session to query for dispatch processors
  • DispatchProcessorSearchSession : a session to search for dispatch processors
  • DispatchProcessorAdminSession : a session to create and delete dispatch processors
  • DispatchProcessorNotificationSession : a session to receive notifications pertaining to dispatch processor changes
  • DispatchProcessorPublisherSession : a session to look up dispatch processor publisher mappings
  • DispatchProcessorPublisherAssignmentSession : a session to manage dispatch processor to publisher mappings
  • DispatchProcessorSmartPublisherSession : a session to manage dynamic publishers of dispatch processors
  • DispatchProcessorRuleLookupSession : a session to look up dispatch processors to dispatch mappings
  • DispatchProcessorRuleApplicationSession : a session to apply dispatch processors to dispatches
  • DispatchProcessorEnablerLookupSession : a session to retrieve dispatch processor enablers
  • DispatchProcessorEnablerQuerySession : a session to query for dispatch processor enablers
  • DispatchProcessorEnablerSearchSession : a session to search for dispatch processor enablers
  • DispatchProcessorEnablerAdminSession : a session to create and delete dispatch processor enablers
  • DispatchProcessorEnablerNotificationSession : a session to receive notifications pertaining to dispatch processor enabler changes
  • DispatchProcessorEnablerPublisherSession : a session to look up dispatch processor enabler publisher mappings
  • DispatchProcessorEnablerPublisherAssignmentSession : a session to manage dispatch processor enabler to publisher mappings
  • DispatchProcessorEnablerSmartPublisherSession : a session to manage dynamic publishers of dispatch processor enablers
  • DispatchProcessorEnablerRuleLookupSession : a session to look up dispatch processor enablers to dispatch processor mappings
  • DispatchProcessorEnablerRuleApplicationSession : a session to apply dispatch processor enablers to dispatch processors
  • 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
MethodgetDispatchEnablerLookupSession
Description

Gets the OsidSession associated with the dispatch enabler lookup service.

Returnosid.subscription.rules.DispatchEnablerLookupSessiona DispatchEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerLookup() is true .
MethodgetDispatchEnablerLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerLookupSessiona DispatchEnablerLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerLookup() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerQuerySession
Description

Gets the OsidSession associated with the dispatch enabler query service.

Returnosid.subscription.rules.DispatchEnablerQuerySessiona DispatchEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerQuery() is true .
MethodgetDispatchEnablerQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerQuerySessiona DispatchEnablerQuerySession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerQuery() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerSearchSession
Description

Gets the OsidSession associated with the dispatch enabler search service.

Returnosid.subscription.rules.DispatchEnablerSearchSessiona DispatchEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerSearch() is true .
MethodgetDispatchEnablerSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerSearchSessiona DispatchEnablerSearchSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerSearch() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerAdminSession
Description

Gets the OsidSession associated with the dispatch enabler administration service.

Returnosid.subscription.rules.DispatchEnablerAdminSessiona DispatchEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerAdmin() is true .
MethodgetDispatchEnablerAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerAdminSessiona DispatchEnablerAdminSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerNotificationSession
Description

Gets the OsidSession associated with the dispatch enabler notification service.

Parametersosid.subscription.rules.DispatchEnablerReceiverdispatchEnablerReceiverthe notification callback
Returnosid.subscription.rules.DispatchEnablerNotificationSessiona DispatchEnablerNotificationSession
ErrorsNULL_ARGUMENTdispatchReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerNotification() is true .
MethodgetDispatchEnablerNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.DispatchEnablerReceiverdispatchEnablerReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerNotificationSessiona DispatchEnablerNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTdispatchEnablerReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerNotification() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerPublisherSession
Description

Gets the OsidSession to lookup dispatch enabler/publisher mappings.

Returnosid.subscription.rules.DispatchEnablerPublisherSessiona DispatchEnablerPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerPublisher() is true .
MethodgetDispatchEnablerPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning dispatch enablers to publishers.

Returnosid.subscription.rules.DispatchEnablerPublisherAssignmentSessiona DispatchEnablerPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerPublisherAssignment() is true .
MethodgetDispatchEnablerSmartPublisherSession
Description

Gets the OsidSession to manage dispatch enabler smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerSmartPublisherSessiona DispatchEnablerSmartPublisherSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerSmartPublisher() is true .
MethodgetDispatchEnablerRuleLookupSession
Description

Gets the OsidSession associated with the dispatch enabler dispatch mapping lookup service for looking up the rules applied to a dispatch.

Returnosid.subscription.rules.DispatchEnablerRuleLookupSessiona DispatchEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerRuleLookup() is true .
MethodgetDispatchEnablerRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the dispatch enabler mapping lookup service for the given publisher for looking up rules applied to a dispatch.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerRuleLookupSessiona DispatchEnablerRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetDispatchEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the dispatch constrainer assignment service to apply to dispatches.

Returnosid.subscription.rules.DispatchEnablerRuleApplicationSessiona DispatchEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerRuleApplication() is true .
MethodgetDispatchEnablerRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the dispatch enabler assignment service for the given publisher to apply to dispatches.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchEnablerRuleApplicationSessiona DispatchEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerLookupSession
Description

Gets the OsidSession associated with the dispatch constrainer lookup service.

Returnosid.subscription.rules.DispatchConstrainerLookupSessiona DispatchConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerLookup() is true .
MethodgetDispatchConstrainerLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerLookupSessiona DispatchConstrainerLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerLookup() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerQuerySession
Description

Gets the OsidSession associated with the dispatch constrainer query service.

Returnosid.subscription.rules.DispatchConstrainerQuerySessiona DispatchConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerQuery() is true .
MethodgetDispatchConstrainerQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerQuerySessiona DispatchConstrainerQuerySession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerQuery() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerSearchSession
Description

Gets the OsidSession associated with the dispatch constrainer search service.

Returnosid.subscription.rules.DispatchConstrainerSearchSessiona DispatchConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerSearch() is true .
MethodgetDispatchConstrainerSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerSearchSessiona DispatchConstrainerSearchSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerSearch() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerAdminSession
Description

Gets the OsidSession associated with the dispatch constrainer administration service.

Returnosid.subscription.rules.DispatchConstrainerAdminSessiona DispatchConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerAdmin() is true .
MethodgetDispatchConstrainerAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerAdminSessiona DispatchConstrainerAdminSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerAdmin() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerNotificationSession
Description

Gets the OsidSession associated with the dispatch constrainer notification service.

Parametersosid.subscription.rules.DispatchConstrainerReceiverdispatchConstrainerReceiverthe notification callback
Returnosid.subscription.rules.DispatchConstrainerNotificationSessiona DispatchConstrainerNotificationSession
ErrorsNULL_ARGUMENTdispatchConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerNotification() is true .
MethodgetDispatchConstrainerNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.DispatchConstrainerReceiverdispatchConstrainerReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerNotificationSessiona DispatchConstrainerNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTdispatchConstrainerReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerNotification() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerPublisherSession
Description

Gets the OsidSession to lookup dispatch constrainer/publisher mappings.

Returnosid.subscription.rules.DispatchConstrainerPublisherSessiona DispatchConstrainerPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerPublisher() is true .
MethodgetDispatchConstrainerPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning dispatch constrainers to publishers.

Returnosid.subscription.rules.DispatchConstrainerPublisherAssignmentSessiona DispatchConstrainerPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerPublisherAssignment() is true .
MethodgetDispatchConstrainerSmartPublisherSession
Description

Gets the OsidSession to manage dispatch constrainer smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerSmartPublisherSessiona DispatchConstrainerSmartPublisherSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerSmartPublisher() is true .
MethodgetDispatchConstrainerRuleLookupSession
Description

Gets the OsidSession associated with the dispatch constrainer dispatch mapping lookup service for looking up the rules applied to a dispatch.

Returnosid.subscription.rules.DispatchConstrainerRuleLookupSessiona DispatchConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerRuleLookup() is true .
MethodgetDispatchConstrainerRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the dispatch constrainer mapping lookup service for the given publisher for looking up rules applied to a dispatch.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerRuleLookupSessiona DispatchConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerRuleLookup() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerRuleApplicationSession
Description

Gets the OsidSession associated with the dispatch constrainer assignment service to apply to dispatches.

Returnosid.subscription.rules.DispatchConstrainerRuleApplicationSessiona DispatchConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerRuleApplication() is true .
MethodgetDispatchConstrainerRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the dispatch constrainer assignment service for the given publisher to apply to dispatches.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerRuleApplicationSessiona DispatchConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerRuleApplication() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerLookupSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler lookup service.

Returnosid.subscription.rules.DispatchConstrainerEnablerLookupSessiona DispatchConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerLookup() is true .
MethodgetDispatchConstrainerEnablerLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerLookupSessiona DispatchConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerLookup() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerQuerySession
Description

Gets the OsidSession associated with the dispatch constrainer enabler query service.

Returnosid.subscription.rules.DispatchConstrainerEnablerQuerySessiona DispatchConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerQuery() is true .
MethodgetDispatchConstrainerEnablerQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerQuerySessiona DispatchConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerQuery() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerSearchSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler search service.

Returnosid.subscription.rules.DispatchConstrainerEnablerSearchSessiona DispatchConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerSearch() is true .
MethodgetDispatchConstrainerEnablerSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerSearchSessiona DispatchConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerSearch() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerAdminSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler administration service.

Returnosid.subscription.rules.DispatchConstrainerEnablerAdminSessiona DispatchConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerAdmin() is true .
MethodgetDispatchConstrainerEnablerAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerAdminSessiona DispatchConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerAdmin() and supportsVisibleFederation() are true
MethodgetDispatchConstrainerEnablerNotificationSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler notification service.

Parametersosid.subscription.rules.DispatchConstrainerEnablerReceiverdispatchConstrainerEnablerReceiverthe notification callback
Returnosid.subscription.rules.DispatchConstrainerEnablerNotificationSessiona DispatchConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENTdispatchConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerNotification() is true .
MethodgetDispatchConstrainerEnablerNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.DispatchConstrainerEnablerReceiverdispatchConstrainerEnablerReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerNotificationSessiona DispatchConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTdispatchConstrainerEnablerReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerNotification() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerPublisherSession
Description

Gets the OsidSession to lookup dispatch constrainer enabler/publisher mappings.

Returnosid.subscription.rules.DispatchConstrainerEnablerPublisherSessiona DispatchConstrainerEnablerPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerPublisher() is true .
MethodgetDispatchConstrainerEnablerPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning dispatch constrainer enablers to publishers.

Returnosid.subscription.rules.DispatchConstrainerEnablerPublisherAssignmentSessiona DispatchConstrainerEnablerPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerPublisherAssignment() is true .
MethodgetDispatchConstrainerEnablerSmartPublisherSession
Description

Gets the OsidSession to manage dispatch constrainer enabler smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerSmartPublisherSessiona DispatchConstrainerEnablerSmartPublisherSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerSmartPublisher() is true .
MethodgetDispatchConstrainerEnablerRuleLookupSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler dispatch mapping lookup service for looking up the rules applied to a dispatch constrainer.

Returnosid.subscription.rules.DispatchConstrainerEnablerRuleLookupSessiona DispatchConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerRuleLookup() is true .
MethodgetDispatchConstrainerEnablerRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the dispatch constrainer enabler mapping lookup service for the given publisher for looking up rules applied to a dispatch constrainer.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerRuleLookupSessiona DispatchConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetDispatchConstrainerEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the dispatch constrainer enabler assignment service to apply to dispatch constrainers.

Returnosid.subscription.rules.DispatchConstrainerEnablerRuleApplicationSessiona DispatchConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnablerRuleApplication() is true .
MethodgetDispatchConstrainerEnablerRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the dispatch constrainer enabler assignment service for the given publisher to apply to dispatch constrainers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchConstrainerEnablerRuleApplicationSessiona DispatchConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchConstrainerEnabelrRuleApplication() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorLookupSession
Description

Gets the OsidSession associated with the dispatch processor lookup service.

Returnosid.subscription.rules.DispatchProcessorLookupSessiona DispatchProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorLookup() is true .
MethodgetDispatchProcessorLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorLookupSessiona DispatchProcessorLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorLookup() and supportsVisibleFederation() are true
MethodgetDispatchProcessorQuerySession
Description

Gets the OsidSession associated with the dispatch processor query service.

Returnosid.subscription.rules.DispatchProcessorQuerySessiona DispatchProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorQuery() is true .
MethodgetDispatchProcessorQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorQuerySessiona DispatchProcessorQuerySession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorQuery() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorSearchSession
Description

Gets the OsidSession associated with the dispatch processor search service.

Returnosid.subscription.rules.DispatchProcessorSearchSessiona DispatchProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorSearch() is true .
MethodgetDispatchProcessorSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorSearchSessiona DispatchProcessorSearchSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorSearch() and supportsVisibleFederation() are true
MethodgetDispatchProcessorAdminSession
Description

Gets the OsidSession associated with the dispatch processor administration service.

Returnosid.subscription.rules.DispatchProcessorAdminSessiona DispatchProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorAdmin() is true .
MethodgetDispatchProcessorAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorAdminSessiona DispatchProcessorAdminSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorAdmin() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorNotificationSession
Description

Gets the OsidSession associated with the dispatch processor notification service.

Parametersosid.subscription.rules.DispatchProcessorReceiverdispatchProcessorReceiverthe notification callback
Returnosid.subscription.rules.DispatchProcessorNotificationSessiona DispatchProcessorNotificationSession
ErrorsNULL_ARGUMENTdispatchConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorNotification() is true .
MethodgetDispatchProcessorNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.DispatchProcessorReceiverdispatchProcessorReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorNotificationSessiona DispatchProcessorNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTdispatchProcessorReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorNotification() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorPublisherSession
Description

Gets the OsidSession to lookup dispatch processor/publisher mappings.

Returnosid.subscription.rules.DispatchProcessorPublisherSessiona DispatchProcessorPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorPublisher() is true .
MethodgetDispatchProcessorPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning dispatch processors to publishers.

Returnosid.subscription.rules.DispatchProcessorPublisherAssignmentSessiona DispatchProcessorPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorPublisherAssignment() is true .
MethodgetDispatchProcessorSmartPublisherSession
Description

Gets the OsidSession to manage dispatch processor smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorSmartPublisherSessiona DispatchProcessorSmartPublisherSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorSmartPublisher() is true .
MethodgetDispatchProcessorRuleLookupSession
Description

Gets the OsidSession associated with the dispatch processor dispatch mapping lookup service for looking up the rules applied to a dispatch.

Returnosid.subscription.rules.DispatchProcessorRuleLookupSessiona DispatchProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorRuleLookup() is true .
MethodgetDispatchProcessorRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the dispatch processor mapping lookup service for the given publisher for looking up rules applied to a dispatches.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorRuleLookupSessiona DispatchProcessorRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorRuleLookup() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorRuleApplicationSession
Description

Gets the OsidSession associated with the dispatch processor assignment service to apply to dispatches.

Returnosid.subscription.rules.DispatchProcessorRuleApplicationSessiona DispatchProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorRuleApplication() is true .
MethodgetDispatchProcessorRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the dispatch processor assignment service for the given publisher to apply to dispatches.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorRuleApplicationSessiona DispatchProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorRuleApplication() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorEnablerLookupSession
Description

Gets the OsidSession associated with the dispatch processor enabler lookup service.

Returnosid.subscription.rules.DispatchProcessorEnablerLookupSessiona DispatchProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerLookup() is true .
MethodgetDispatchProcessorEnablerLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerLookupSessiona DispatchProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerLookup() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorEnablerQuerySession
Description

Gets the OsidSession associated with the dispatch processor enabler query service.

Returnosid.subscription.rules.DispatchProcessorEnablerQuerySessiona DispatchProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerQuery() is true .
MethodgetDispatchProcessorEnablerQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerQuerySessiona DispatchProcessorEnablerQuerySession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerQuery() and supportsVisibleFederation() are true
MethodgetDispatchProcessorEnablerSearchSession
Description

Gets the OsidSession associated with the dispatch processor enabler search service.

Returnosid.subscription.rules.DispatchProcessorEnablerSearchSessiona DispatchProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerSearch() is true .
MethodgetDispatchProcessorEnablerSearchSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerSearchSessiona DispatchProcessorEnablerSearchSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerSearch() and supportsVisibleFederation() are true
MethodgetDispatchProcessorEnablerAdminSession
Description

Gets the OsidSession associated with the dispatch processor enabler administration service.

Returnosid.subscription.rules.DispatchProcessorEnablerAdminSessiona DispatchProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerAdmin() is true .
MethodgetDispatchProcessorEnablerAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerAdminSessiona DispatchProcessorEnablerAdminSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerAdmin() and supportsVisibleFederation() are true
MethodgetDispatchProcessorEnablerNotificationSession
Description

Gets the OsidSession associated with the dispatch processor enabler notification service.

Parametersosid.subscription.rules.DispatchProcessorEnablerReceiverdispatchProcessorEnablerReceiverthe notification callback
Returnosid.subscription.rules.DispatchProcessorEnablerNotificationSessiona DispatchProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENTdispatchProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerNotification() is true .
MethodgetDispatchProcessorEnablerNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.DispatchProcessorEnablerReceiverdispatchProcessorEnablerReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerNotificationSessiona DispatchProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTdispatchProcessorEnablerReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerNotification() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorEnablerPublisherSession
Description

Gets the OsidSession to lookup dispatch processor enabler/publisher mappings.

Returnosid.subscription.rules.DispatchProcessorEnablerPublisherSessiona DispatchProcessorEnablerPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerPublisher() is true .
MethodgetDispatchProcessorEnablerPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning dispatch processors enablers to publishers.

Returnosid.subscription.rules.DispatchProcessorEnablerPublisherAssignmentSessiona DispatchProcessorEnablerPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerPublisherAssignment() is true .
MethodgetDispatchProcessorEnablerSmartPublisherSession
Description

Gets the OsidSession to manage dispatch processor enabler smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerSmartPublisherSessiona DispatchProcessorEnablerSmartPublisherSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerSmartPublisher() is true .
MethodgetDispatchProcessorEnablerRuleLookupSession
Description

Gets the OsidSession associated with the dispatch processor enabler dispatch mapping lookup service for looking up the rules applied to a dispatch processor.

Returnosid.subscription.rules.DispatchProcessorEnablerRuleLookupSessiona DispatchProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerRuleLookup() is true .
MethodgetDispatchProcessorEnablerRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the dispatch processor enabler mapping lookup service for the given publisher for looking up rules applied to a dispatch processors.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerRuleLookupSessiona DispatchProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetDispatchProcessorEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the dispatch processor enabler assignment service to apply to dispatch processors.

Returnosid.subscription.rules.DispatchProcessorEnablerRuleApplicationSessiona DispatchProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnablerRuleApplication() is true .
MethodgetDispatchProcessorEnablerRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the dispatch processor enabler assignment service for the given publisher to apply to dispatch processors.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.DispatchProcessorEnablerRuleApplicationSessiona DispatchProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDispatchProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDispatchProcessorEnabelrRuleApplication() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerLookupSession
Description

Gets the OsidSession associated with the subscription enabler lookup service.

Returnosid.subscription.rules.SubscriptionEnablerLookupSessiona SubscriptionEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerLookup() is true .
MethodgetSubscriptionEnablerLookupSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerLookupSessiona SubscriptionEnablerLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerLookup() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerQuerySession
Description

Gets the OsidSession associated with the subscription enabler query service.

Returnosid.subscription.rules.SubscriptionEnablerQuerySessiona SubscriptionEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerQuery() is true .
MethodgetSubscriptionEnablerQuerySessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerQuerySessiona SubscriptionEnablerQuerySession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerQuery() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerSearchSession
Description

Gets the OsidSession associated with the subscription enabler search service.

Returnosid.subscription.rules.SubscriptionEnablerSearchSessiona SubscriptionEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerSearch() is true .
MethodgetSubscriptionEnablerSearchSessionForPublisher
Description

Gets the OsidSession associated with the subscription enablers earch service for the given publisher.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerSearchSessiona SubscriptionEnablerSearchSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerSearch() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerAdminSession
Description

Gets the OsidSession associated with the subscription enabler administration service.

Returnosid.subscription.rules.SubscriptionEnablerAdminSessiona SubscriptionEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerAdmin() is true .
MethodgetSubscriptionEnablerAdminSessionForPublisher
Description

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

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerAdminSessiona SubscriptionEnablerAdminSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerNotificationSession
Description

Gets the OsidSession associated with the subscription enabler notification service.

Parametersosid.subscription.rules.SubscriptionEnablerReceiversubscriptionEnablerReceiverthe notification callback
Returnosid.subscription.rules.SubscriptionEnablerNotificationSessiona SubscriptionEnablerNotificationSession
ErrorsNULL_ARGUMENTsubscriptionEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerNotification() is true .
MethodgetSubscriptionEnablerNotificationSessionForPublisher
Description

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

Parametersosid.subscription.rules.SubscriptionEnablerReceiversubscriptionEnablerReceiverthe notification callback
osid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerNotificationSessiona SubscriptionEnablerNotificationSession
ErrorsNOT_FOUNDno publisher found by the given Id
NULL_ARGUMENTsubscriptionEnablerReceiver or publisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerNotification() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerPublisherSession
Description

Gets the OsidSession to lookup subscription enablerpublisher mappings.

Returnosid.subscription.rules.SubscriptionEnablerPublisherSessiona SubscriptionEnablerPublisherSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerPublisher() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerPublisher() is true .
MethodgetSubscriptionEnablerPublisherAssignmentSession
Description

Gets the OsidSession associated with assigning subscription enablers to publishers.

Returnosid.subscription.rules.SubscriptionEnablerPublisherAssignmentSessiona SubscriptionEnablerPublisherAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerPublisherAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerPublisherAssignment() is true .
MethodgetSubscriptionEnablerSmartPublisherSession
Description

Gets the OsidSession to manage subscription enabler smart publishers.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerSmartPublisherSessiona SubscriptionEnablerSmartPublisherSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerSmartPublisher() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerSmartPublisher() is true .
MethodgetSubscriptionEnablerRuleLookupSession
Description

Gets the OsidSession associated with the subscription enabler mapping lookup service for looking up the rules applied to the subscription.

Returnosid.subscription.rules.SubscriptionEnablerRuleLookupSessiona SubscriptionEnablerRuleSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerRuleLookup() is true .
MethodgetSubscriptionEnablerRuleLookupSessionForPublisher
Description

Gets the OsidSession associated with the subscription enabler mapping lookup service for the given subscription for looking up rules applied to a subscription.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerRuleLookupSessiona SubscriptionEnablerRuleLookupSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetSubscriptionEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the subscription enabler assignment service to apply enablers to subscriptions.

Returnosid.subscription.rules.SubscriptionEnablerRuleApplicationSessiona SubscriptionEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerRuleApplication() is true .
MethodgetSubscriptionEnablerRuleApplicationSessionForPublisher
Description

Gets the OsidSession associated with the subscription enabler assignment service for the given subscription to apply enablers to subscriptions.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerRuleApplicationSessiona SubscriptionEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Publisher found by the given Id
NULL_ARGUMENTpublisherId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubscriptionEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionEnablerRuleApplication() and supportsVisibleFederation() are true .