Interface SubscriptionRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, SubscriptionRulesProfile
public interface SubscriptionRulesManager extends OsidManager, SubscriptionRulesProfile

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

  • Method Details

    • getDispatchEnablerLookupSession

      DispatchEnablerLookupSession getDispatchEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler lookup service.
      Returns:
      a DispatchEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerLookup()} is {@code true} .

    • getDispatchEnablerLookupSessionForPublisher

      DispatchEnablerLookupSession getDispatchEnablerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerQuerySession

      DispatchEnablerQuerySession getDispatchEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler query service.
      Returns:
      a DispatchEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerQuery()} is {@code true} .

    • getDispatchEnablerQuerySessionForPublisher

      DispatchEnablerQuerySession getDispatchEnablerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerQuerySession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerSearchSession

      DispatchEnablerSearchSession getDispatchEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler search service.
      Returns:
      a DispatchEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerSearch()} is {@code true} .

    • getDispatchEnablerSearchSessionForPublisher

      DispatchEnablerSearchSession getDispatchEnablerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler search service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerSearchSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerAdminSession

      DispatchEnablerAdminSession getDispatchEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler administration service.
      Returns:
      a DispatchEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerAdmin()} is {@code true} .

    • getDispatchEnablerAdminSessionForPublisher

      DispatchEnablerAdminSession getDispatchEnablerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerAdminSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerNotificationSession

      DispatchEnablerNotificationSession getDispatchEnablerNotificationSession(DispatchEnablerReceiver dispatchEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler notification service.
      Parameters:
      dispatchEnablerReceiver - the notification callback
      Returns:
      a DispatchEnablerNotificationSession
      Throws:
      NullArgumentException - dispatchReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerNotification()} is {@code true} .

    • getDispatchEnablerNotificationSessionForPublisher

      DispatchEnablerNotificationSession getDispatchEnablerNotificationSessionForPublisher(DispatchEnablerReceiver dispatchEnablerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler notification service for the given publisher.
      Parameters:
      dispatchEnablerReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - dispatchEnablerReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerPublisherSession

      DispatchEnablerPublisherSession getDispatchEnablerPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup dispatch enabler/publisher mappings.
      Returns:
      a DispatchEnablerPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerPublisher()} is {@code true} .

    • getDispatchEnablerPublisherAssignmentSession

      DispatchEnablerPublisherAssignmentSession getDispatchEnablerPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning dispatch enablers to publishers.
      Returns:
      a DispatchEnablerPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerPublisherAssignment()} is {@code true} .

    • getDispatchEnablerSmartPublisherSession

      DispatchEnablerSmartPublisherSession getDispatchEnablerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage dispatch enabler smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerSmartPublisherSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerSmartPublisher()} is {@code true} .

    • getDispatchEnablerRuleLookupSession

      DispatchEnablerRuleLookupSession getDispatchEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch enabler dispatch mapping lookup service for looking up the rules applied to a dispatch.
      Returns:
      a DispatchEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerRuleLookup()} is {@code true} .

    • getDispatchEnablerRuleLookupSessionForPublisher

      DispatchEnablerRuleLookupSession getDispatchEnablerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler mapping lookup service for the given publisher for looking up rules applied to a dispatch.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchEnablerRuleApplicationSession

      DispatchEnablerRuleApplicationSession getDispatchEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer assignment service to apply to dispatches.
      Returns:
      a DispatchEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerRuleApplication()} is {@code true} .

    • getDispatchEnablerRuleApplicationSessionForPublisher

      DispatchEnablerRuleApplicationSession getDispatchEnablerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch enabler assignment service for the given publisher to apply to dispatches.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerLookupSession

      DispatchConstrainerLookupSession getDispatchConstrainerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer lookup service.
      Returns:
      a DispatchConstrainerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerLookup()} is {@code true} .

    • getDispatchConstrainerLookupSessionForPublisher

      DispatchConstrainerLookupSession getDispatchConstrainerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerQuerySession

      DispatchConstrainerQuerySession getDispatchConstrainerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer query service.
      Returns:
      a DispatchConstrainerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerQuery()} is {@code true} .

    • getDispatchConstrainerQuerySessionForPublisher

      DispatchConstrainerQuerySession getDispatchConstrainerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerQuerySession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerSearchSession

      DispatchConstrainerSearchSession getDispatchConstrainerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer search service.
      Returns:
      a DispatchConstrainerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerSearch()} is {@code true} .

    • getDispatchConstrainerSearchSessionForPublisher

      DispatchConstrainerSearchSession getDispatchConstrainerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer search service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerSearchSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerAdminSession

      DispatchConstrainerAdminSession getDispatchConstrainerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer administration service.
      Returns:
      a DispatchConstrainerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerAdmin()} is {@code true} .

    • getDispatchConstrainerAdminSessionForPublisher

      DispatchConstrainerAdminSession getDispatchConstrainerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerAdminSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerNotificationSession

      DispatchConstrainerNotificationSession getDispatchConstrainerNotificationSession(DispatchConstrainerReceiver dispatchConstrainerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer notification service.
      Parameters:
      dispatchConstrainerReceiver - the notification callback
      Returns:
      a DispatchConstrainerNotificationSession
      Throws:
      NullArgumentException - dispatchConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerNotification()} is {@code true} .

    • getDispatchConstrainerNotificationSessionForPublisher

      DispatchConstrainerNotificationSession getDispatchConstrainerNotificationSessionForPublisher(DispatchConstrainerReceiver dispatchConstrainerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer notification service for the given publisher.
      Parameters:
      dispatchConstrainerReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - dispatchConstrainerReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerPublisherSession

      DispatchConstrainerPublisherSession getDispatchConstrainerPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup dispatch constrainer/publisher mappings.
      Returns:
      a DispatchConstrainerPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerPublisher()} is {@code true} .

    • getDispatchConstrainerPublisherAssignmentSession

      DispatchConstrainerPublisherAssignmentSession getDispatchConstrainerPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning dispatch constrainers to publishers.
      Returns:
      a DispatchConstrainerPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerPublisherAssignment()} is {@code true} .

    • getDispatchConstrainerSmartPublisherSession

      DispatchConstrainerSmartPublisherSession getDispatchConstrainerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage dispatch constrainer smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerSmartPublisherSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerSmartPublisher()} is {@code true} .

    • getDispatchConstrainerRuleLookupSession

      DispatchConstrainerRuleLookupSession getDispatchConstrainerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer dispatch mapping lookup service for looking up the rules applied to a dispatch.
      Returns:
      a DispatchConstrainerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerRuleLookup()} is {@code true} .

    • getDispatchConstrainerRuleLookupSessionForPublisher

      DispatchConstrainerRuleLookupSession getDispatchConstrainerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer mapping lookup service for the given publisher for looking up rules applied to a dispatch.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerRuleApplicationSession

      DispatchConstrainerRuleApplicationSession getDispatchConstrainerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer assignment service to apply to dispatches.
      Returns:
      a DispatchConstrainerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerRuleApplication()} is {@code true} .

    • getDispatchConstrainerRuleApplicationSessionForPublisher

      DispatchConstrainerRuleApplicationSession getDispatchConstrainerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer assignment service for the given publisher to apply to dispatches.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerLookupSession

      DispatchConstrainerEnablerLookupSession getDispatchConstrainerEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler lookup service.
      Returns:
      a DispatchConstrainerEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerLookup()} is {@code true} .

    • getDispatchConstrainerEnablerLookupSessionForPublisher

      DispatchConstrainerEnablerLookupSession getDispatchConstrainerEnablerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerQuerySession

      DispatchConstrainerEnablerQuerySession getDispatchConstrainerEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler query service.
      Returns:
      a DispatchConstrainerEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerQuery()} is {@code true} .

    • getDispatchConstrainerEnablerQuerySessionForPublisher

      DispatchConstrainerEnablerQuerySession getDispatchConstrainerEnablerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerSearchSession

      DispatchConstrainerEnablerSearchSession getDispatchConstrainerEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler search service.
      Returns:
      a DispatchConstrainerEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerSearch()} is {@code true} .

    • getDispatchConstrainerEnablerSearchSessionForPublisher

      DispatchConstrainerEnablerSearchSession getDispatchConstrainerEnablerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler search service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerAdminSession

      DispatchConstrainerEnablerAdminSession getDispatchConstrainerEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler administration service.
      Returns:
      a DispatchConstrainerEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerAdmin()} is {@code true} .

    • getDispatchConstrainerEnablerAdminSessionForPublisher

      DispatchConstrainerEnablerAdminSession getDispatchConstrainerEnablerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchConstrainerEnablerNotificationSession

      DispatchConstrainerEnablerNotificationSession getDispatchConstrainerEnablerNotificationSession(DispatchConstrainerEnablerReceiver dispatchConstrainerEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler notification service.
      Parameters:
      dispatchConstrainerEnablerReceiver - the notification callback
      Returns:
      a DispatchConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - dispatchConstrainerEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerNotification()} is {@code true} .

    • getDispatchConstrainerEnablerNotificationSessionForPublisher

      DispatchConstrainerEnablerNotificationSession getDispatchConstrainerEnablerNotificationSessionForPublisher(DispatchConstrainerEnablerReceiver dispatchConstrainerEnablerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler notification service for the given publisher.
      Parameters:
      dispatchConstrainerEnablerReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - dispatchConstrainerEnablerReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerPublisherSession

      DispatchConstrainerEnablerPublisherSession getDispatchConstrainerEnablerPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup dispatch constrainer enabler/publisher mappings.
      Returns:
      a DispatchConstrainerEnablerPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerPublisher()} is {@code true} .

    • getDispatchConstrainerEnablerPublisherAssignmentSession

      DispatchConstrainerEnablerPublisherAssignmentSession getDispatchConstrainerEnablerPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning dispatch constrainer enablers to publishers.
      Returns:
      a DispatchConstrainerEnablerPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerPublisherAssignment()} is {@code true} .

    • getDispatchConstrainerEnablerSmartPublisherSession

      DispatchConstrainerEnablerSmartPublisherSession getDispatchConstrainerEnablerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage dispatch constrainer enabler smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerSmartPublisherSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerSmartPublisher()} is {@code true} .

    • getDispatchConstrainerEnablerRuleLookupSession

      DispatchConstrainerEnablerRuleLookupSession getDispatchConstrainerEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler dispatch mapping lookup service for looking up the rules applied to a dispatch constrainer.
      Returns:
      a DispatchConstrainerEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerRuleLookup()} is {@code true} .

    • getDispatchConstrainerEnablerRuleLookupSessionForPublisher

      DispatchConstrainerEnablerRuleLookupSession getDispatchConstrainerEnablerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      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.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchConstrainerEnablerRuleApplicationSession

      DispatchConstrainerEnablerRuleApplicationSession getDispatchConstrainerEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler assignment service to apply to dispatch constrainers.
      Returns:
      a DispatchConstrainerEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnablerRuleApplication()} is {@code true} .

    • getDispatchConstrainerEnablerRuleApplicationSessionForPublisher

      DispatchConstrainerEnablerRuleApplicationSession getDispatchConstrainerEnablerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch constrainer enabler assignment service for the given publisher to apply to dispatch constrainers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchConstrainerEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorLookupSession

      DispatchProcessorLookupSession getDispatchProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor lookup service.
      Returns:
      a DispatchProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorLookup()} is {@code true} .

    • getDispatchProcessorLookupSessionForPublisher

      DispatchProcessorLookupSession getDispatchProcessorLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchProcessorQuerySession

      DispatchProcessorQuerySession getDispatchProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor query service.
      Returns:
      a DispatchProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorQuery()} is {@code true} .

    • getDispatchProcessorQuerySessionForPublisher

      DispatchProcessorQuerySession getDispatchProcessorQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorQuerySession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorSearchSession

      DispatchProcessorSearchSession getDispatchProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor search service.
      Returns:
      a DispatchProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorSearch()} is {@code true} .

    • getDispatchProcessorSearchSessionForPublisher

      DispatchProcessorSearchSession getDispatchProcessorSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor search service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorSearchSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchProcessorAdminSession

      DispatchProcessorAdminSession getDispatchProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor administration service.
      Returns:
      a DispatchProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorAdmin()} is {@code true} .

    • getDispatchProcessorAdminSessionForPublisher

      DispatchProcessorAdminSession getDispatchProcessorAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorAdminSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorNotificationSession

      DispatchProcessorNotificationSession getDispatchProcessorNotificationSession(DispatchProcessorReceiver dispatchProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor notification service.
      Parameters:
      dispatchProcessorReceiver - the notification callback
      Returns:
      a DispatchProcessorNotificationSession
      Throws:
      NullArgumentException - dispatchConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorNotification()} is {@code true} .

    • getDispatchProcessorNotificationSessionForPublisher

      DispatchProcessorNotificationSession getDispatchProcessorNotificationSessionForPublisher(DispatchProcessorReceiver dispatchProcessorReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor notification service for the given publisher.
      Parameters:
      dispatchProcessorReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - dispatchProcessorReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorPublisherSession

      DispatchProcessorPublisherSession getDispatchProcessorPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup dispatch processor/publisher mappings.
      Returns:
      a DispatchProcessorPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorPublisher()} is {@code true} .

    • getDispatchProcessorPublisherAssignmentSession

      DispatchProcessorPublisherAssignmentSession getDispatchProcessorPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning dispatch processors to publishers.
      Returns:
      a DispatchProcessorPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorPublisherAssignment()} is {@code true} .

    • getDispatchProcessorSmartPublisherSession

      DispatchProcessorSmartPublisherSession getDispatchProcessorSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage dispatch processor smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorSmartPublisherSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorSmartPublisher()} is {@code true} .

    • getDispatchProcessorRuleLookupSession

      DispatchProcessorRuleLookupSession getDispatchProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor dispatch mapping lookup service for looking up the rules applied to a dispatch.
      Returns:
      a DispatchProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorRuleLookup()} is {@code true} .

    • getDispatchProcessorRuleLookupSessionForPublisher

      DispatchProcessorRuleLookupSession getDispatchProcessorRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor mapping lookup service for the given publisher for looking up rules applied to a dispatches.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorRuleApplicationSession

      DispatchProcessorRuleApplicationSession getDispatchProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor assignment service to apply to dispatches.
      Returns:
      a DispatchProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorRuleApplication()} is {@code true} .

    • getDispatchProcessorRuleApplicationSessionForPublisher

      DispatchProcessorRuleApplicationSession getDispatchProcessorRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor assignment service for the given publisher to apply to dispatches.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorEnablerLookupSession

      DispatchProcessorEnablerLookupSession getDispatchProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler lookup service.
      Returns:
      a DispatchProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerLookup()} is {@code true} .

    • getDispatchProcessorEnablerLookupSessionForPublisher

      DispatchProcessorEnablerLookupSession getDispatchProcessorEnablerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorEnablerQuerySession

      DispatchProcessorEnablerQuerySession getDispatchProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler query service.
      Returns:
      a DispatchProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerQuery()} is {@code true} .

    • getDispatchProcessorEnablerQuerySessionForPublisher

      DispatchProcessorEnablerQuerySession getDispatchProcessorEnablerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerQuerySession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchProcessorEnablerSearchSession

      DispatchProcessorEnablerSearchSession getDispatchProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler search service.
      Returns:
      a DispatchProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerSearch()} is {@code true} .

    • getDispatchProcessorEnablerSearchSessionForPublisher

      DispatchProcessorEnablerSearchSession getDispatchProcessorEnablerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler search service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerSearchSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchProcessorEnablerAdminSession

      DispatchProcessorEnablerAdminSession getDispatchProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler administration service.
      Returns:
      a DispatchProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerAdmin()} is {@code true} .

    • getDispatchProcessorEnablerAdminSessionForPublisher

      DispatchProcessorEnablerAdminSession getDispatchProcessorEnablerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerAdminSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getDispatchProcessorEnablerNotificationSession

      DispatchProcessorEnablerNotificationSession getDispatchProcessorEnablerNotificationSession(DispatchProcessorEnablerReceiver dispatchProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler notification service.
      Parameters:
      dispatchProcessorEnablerReceiver - the notification callback
      Returns:
      a DispatchProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - dispatchProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerNotification()} is {@code true} .

    • getDispatchProcessorEnablerNotificationSessionForPublisher

      DispatchProcessorEnablerNotificationSession getDispatchProcessorEnablerNotificationSessionForPublisher(DispatchProcessorEnablerReceiver dispatchProcessorEnablerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler notification service for the given publisher.
      Parameters:
      dispatchProcessorEnablerReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - dispatchProcessorEnablerReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorEnablerPublisherSession

      DispatchProcessorEnablerPublisherSession getDispatchProcessorEnablerPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup dispatch processor enabler/publisher mappings.
      Returns:
      a DispatchProcessorEnablerPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerPublisher()} is {@code true} .

    • getDispatchProcessorEnablerPublisherAssignmentSession

      DispatchProcessorEnablerPublisherAssignmentSession getDispatchProcessorEnablerPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning dispatch processors enablers to publishers.
      Returns:
      a DispatchProcessorEnablerPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerPublisherAssignment()} is {@code true} .

    • getDispatchProcessorEnablerSmartPublisherSession

      DispatchProcessorEnablerSmartPublisherSession getDispatchProcessorEnablerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage dispatch processor enabler smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerSmartPublisherSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerSmartPublisher()} is {@code true} .

    • getDispatchProcessorEnablerRuleLookupSession

      DispatchProcessorEnablerRuleLookupSession getDispatchProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler dispatch mapping lookup service for looking up the rules applied to a dispatch processor.
      Returns:
      a DispatchProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerRuleLookup()} is {@code true} .

    • getDispatchProcessorEnablerRuleLookupSessionForPublisher

      DispatchProcessorEnablerRuleLookupSession getDispatchProcessorEnablerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      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.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getDispatchProcessorEnablerRuleApplicationSession

      DispatchProcessorEnablerRuleApplicationSession getDispatchProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler assignment service to apply to dispatch processors.
      Returns:
      a DispatchProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnablerRuleApplication()} is {@code true} .

    • getDispatchProcessorEnablerRuleApplicationSessionForPublisher

      DispatchProcessorEnablerRuleApplicationSession getDispatchProcessorEnablerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the dispatch processor enabler assignment service for the given publisher to apply to dispatch processors.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a DispatchProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDispatchProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchProcessorEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerLookupSession

      SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler lookup service.
      Returns:
      a SubscriptionEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerLookup()} is {@code true} .

    • getSubscriptionEnablerLookupSessionForPublisher

      SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler lookup service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerQuerySession

      SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler query service.
      Returns:
      a SubscriptionEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerQuery()} is {@code true} .

    • getSubscriptionEnablerQuerySessionForPublisher

      SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler query service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerQuerySession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerSearchSession

      SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler search service.
      Returns:
      a SubscriptionEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerSearch()} is {@code true} .

    • getSubscriptionEnablerSearchSessionForPublisher

      SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enablers earch service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerSearchSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerAdminSession

      SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler administration service.
      Returns:
      a SubscriptionEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerAdmin()} is {@code true} .

    • getSubscriptionEnablerAdminSessionForPublisher

      SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler administration service for the given publisher.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerAdminSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerNotificationSession

      SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSession(SubscriptionEnablerReceiver subscriptionEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler notification service.
      Parameters:
      subscriptionEnablerReceiver - the notification callback
      Returns:
      a SubscriptionEnablerNotificationSession
      Throws:
      NullArgumentException - subscriptionEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerNotification()} is {@code true} .

    • getSubscriptionEnablerNotificationSessionForPublisher

      SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSessionForPublisher(SubscriptionEnablerReceiver subscriptionEnablerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler notification service for the given publisher.
      Parameters:
      subscriptionEnablerReceiver - the notification callback
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerNotificationSession
      Throws:
      NotFoundException - no publisher found by the given Id
      NullArgumentException - subscriptionEnablerReceiver or publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerPublisherSession

      SubscriptionEnablerPublisherSession getSubscriptionEnablerPublisherSession() throws OperationFailedException
      Gets the OsidSession to lookup subscription enablerpublisher mappings.
      Returns:
      a SubscriptionEnablerPublisherSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerPublisher()} is {@code true} .

    • getSubscriptionEnablerPublisherAssignmentSession

      SubscriptionEnablerPublisherAssignmentSession getSubscriptionEnablerPublisherAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning subscription enablers to publishers.
      Returns:
      a SubscriptionEnablerPublisherAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerPublisherAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerPublisherAssignment()} is {@code true} .

    • getSubscriptionEnablerSmartPublisherSession

      SubscriptionEnablerSmartPublisherSession getSubscriptionEnablerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage subscription enabler smart publishers.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerSmartPublisherSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerSmartPublisher() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerSmartPublisher()} is {@code true} .

    • getSubscriptionEnablerRuleLookupSession

      SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler mapping lookup service for looking up the rules applied to the subscription.
      Returns:
      a SubscriptionEnablerRuleSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerRuleLookup()} is {@code true} .

    • getSubscriptionEnablerRuleLookupSessionForPublisher

      SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler mapping lookup service for the given subscription for looking up rules applied to a subscription.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerRuleLookupSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getSubscriptionEnablerRuleApplicationSession

      SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the subscription enabler assignment service to apply enablers to subscriptions.
      Returns:
      a SubscriptionEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerRuleApplication()} is {@code true} .

    • getSubscriptionEnablerRuleApplicationSessionForPublisher

      SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the subscription enabler assignment service for the given subscription to apply enablers to subscriptions.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      a SubscriptionEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Publisher found by the given Id
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubscriptionEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .