Interface VoteEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to VoteEnablers in this Polls . This also includes existing vote enablers that may appear or disappear due to changes in the Polls hierarch y, 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 VoteEnablerLookupSession .

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

    • canRegisterForVoteEnablerNotifications

      boolean canRegisterForVoteEnablerNotifications()
      Tests if this user can register for VoteEnabler 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 vote 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.

    • reliableVoteEnablerNotifications

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

    • unreliableVoteEnablerNotifications

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

    • acknowledgeVoteEnablerNotification

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

    • registerForNewVoteEnablers

      void registerForNewVoteEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new vote enablers. VoteEnablerReceiver.newVoteEnablers() is invoked when a new VoteEnabler appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVoteEnablers

      void registerForChangedVoteEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated vote enablers. VoteEnablerReceiver.changedVoteEnablers() is invoked when a VoteEnabler in this polls is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVoteEnabler

      void registerForChangedVoteEnabler(Id voteEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated vote enabler. VoteEnablerReceiver.changedVoteEnablers() is invoked when the specified VoteEnabler in this polls is changed.
      Parameters:
      voteEnablerId - the Id of the VoteEnabler to monitor
      Throws:
      NullArgumentException - voteEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedVoteEnablers

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

    • registerForDeletedVoteEnabler

      void registerForDeletedVoteEnabler(Id voteEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted vote enabler. VoteEnablerReceiver.deletedVoteEnabler() is invoked when the specified vote enabler is deleted or removed from this polls.
      Parameters:
      voteEnablerId - the Id of the VoteEnabler to monitor
      Throws:
      NullArgumentException - voteEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.