Interface RaceProcessorEnablerNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RaceProcessorEnablerNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to RaceProcessorEnabler objects in this Polls . This also includes existing RaceProcessorEnablers that may appear or disappear due to changes in the Polls hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the RaceProcessorEnablerLookupSession .

  • Method Details

    • getPollsId

      Id getPollsId()
      Gets the Polls Id associated with this session.
      Returns:
      the Polls Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getPolls

      Polls getPolls() throws OperationFailedException, PermissionDeniedException
      Gets the Polls associated with this session.
      Returns:
      the polls
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForRaceProcessorEnablerNotifications

      boolean canRegisterForRaceProcessorEnablerNotifications()
      Tests if this user can register for RaceProcessorEnabler notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedPollsView

      void useFederatedPollsView()
      Federates the view for methods in this session. A federated view will include enablers in polls which are children of this polls in the polls hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPollsView

      void useIsolatedPollsView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this polls only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableRaceProcessorEnablerNotifications

      void reliableRaceProcessorEnablerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRaceProcessorEnablerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableRaceProcessorEnablerNotifications

      void unreliableRaceProcessorEnablerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeRaceProcessorEnablerNotification

      void acknowledgeRaceProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a race processor enabler notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRaceProcessorEnablers

      void registerForNewRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new race processor enablers. RaceProcessorEnablerReceiver.newRaceProcessorEnablers() is invoked when a new RaceProcessorEnabler appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaceProcessorEnablers

      void registerForChangedRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated polls enabelrs. RaceProcessorEnablerReceiver.changedRaceProcessorEnablers() is invoked when a race processor enabler in this polls is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaceProcessorEnabler

      void registerForChangedRaceProcessorEnabler(Id raceProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated race processor enabler. ProvisionableReceiver.changedRaceProcessorEnablers() is invoked when the specified race processor enabler in this polls is changed.
      Parameters:
      raceProcessorEnablerId - the Id of the RaceProcessorEnabler to monitor
      Throws:
      NullArgumentException - raceProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRaceProcessorEnablers

      void registerForDeletedRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted race processor enablers. RaceProcessorEnablerReceiver.deletedRaceProcessorEnablers() is invoked when a race processor enabler is deleted or removed from this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRaceProcessorEnabler

      void registerForDeletedRaceProcessorEnabler(Id raceProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted race processor enabler. RaceProcessorEnablerReceiver.deletedRaceProcessorEnablers() is invoked when the specified race processor enabler is deleted or removed from this polls.
      Parameters:
      raceProcessorEnablerId - the Id of the RaceProcessorEnabler to monitor
      Throws:
      NullArgumentException - raceProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.