Interface RaceNotificationSession

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

This session defines methods to receive notifications on new or deleted races. 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.

This session registers notifications for the Race itself.

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForRaceNotifications

      boolean canRegisterForRaceNotifications()
      Tests if this user can register for Race 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 races from parent 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 for races to this polls only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableRaceNotifications

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

    • unreliableRaceNotifications

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

    • acknowledgeRaceNotification

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

    • registerForNewRaces

      void registerForNewRaces() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new races. RaceReceiver.newRaces() is invoked when a new Race is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRacesForBallot

      void registerForNewRacesForBallot(Id ballotId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new races for a ballot. RaceReceiver.newRaces() is invoked when a new Race is created.
      Parameters:
      ballotId - the Id of the Ballot to monitor
      Throws:
      NullArgumentException - ballotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaces

      void registerForChangedRaces() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new races. RaceReceiver.changedRaces() is invoked when a Race is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRacesForBallot

      void registerForChangedRacesForBallot(Id ballotId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated races for a ballot. RaceReceiver.changedRaces() is invoked when the specified race in this polls is changed.
      Parameters:
      ballotId - the Id of the Ballot to monitor
      Throws:
      NullArgumentException - ballotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRace

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

    • registerForDeletedRaces

      void registerForDeletedRaces() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted races. RaceReceiver.deletedRaces() is invoked when a race is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRacesForBallot

      void registerForDeletedRacesForBallot(Id ballotId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted races for ballot. RaceReceiver.deletedRaces() is invoked when the specified race is deleted or removed from this polls.
      Parameters:
      ballotId - the Id of the Ballot to monitor
      Throws:
      NullArgumentException - ballotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRace

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