Interface RaceConstrainerNotificationSession

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

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

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

    • canRegisterForRaceConstrainerNotifications

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

    • reliableRaceConstrainerNotifications

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

    • unreliableRaceConstrainerNotifications

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

    • acknowledgeRaceConstrainerNotification

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

    • registerForNewRaceConstrainers

      void registerForNewRaceConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new race constrainers. RaceConstrainerReceiver.newRaceConstrainers() is invoked when a new RaceConstrainer appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaceConstrainers

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

    • registerForChangedRaceConstrainer

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

    • registerForDeletedRaceConstrainers

      void registerForDeletedRaceConstrainers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted race constrainers. RaceConstrainerReceiver.deletedRaceConstrainers() is invoked when a race constrainer is deleted or removed from this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRaceConstrainer

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