Interface RaceProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to RaceProcessor objects in this Polls . This also includes existing RaceProcessors 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 RaceProcessorLookupSession .

  • 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.

    • canRegisterForRaceProcessorNotifications

      boolean canRegisterForRaceProcessorNotifications()
      Tests if this user can register for RaceProcessor 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 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.

    • reliableRaceProcessorNotifications

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

    • unreliableRaceProcessorNotifications

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

    • acknowledgeRaceProcessorNotification

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

    • registerForNewRaceProcessors

      void registerForNewRaceProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new race processors. RaceProcessorReceiver.newRaceProcessors() is invoked when a new RaceProcessor appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaceProcessors

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

    • registerForChangedRaceProcessor

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

    • registerForDeletedRaceProcessors

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

    • registerForDeletedRaceProcessor

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