Interface RaceConstrainerEnablerNotificationSession

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

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

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

    • canRegisterForRaceConstrainerEnablerNotifications

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

    • reliableRaceConstrainerEnablerNotifications

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

    • unreliableRaceConstrainerEnablerNotifications

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

    • acknowledgeRaceConstrainerEnablerNotification

      void acknowledgeRaceConstrainerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a race constrainer 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.

    • registerForNewRaceConstrainerEnablers

      void registerForNewRaceConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new race constrainer enablers. RaceConstrainerEnablerReceiver.newRaceConstrainerEnablers() is invoked when a new RaceConstrainerEnabler appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRaceConstrainerEnablers

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

    • registerForChangedRaceConstrainerEnabler

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

    • registerForDeletedRaceConstrainerEnablers

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

    • registerForDeletedRaceConstrainerEnabler

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