Interface BallotConstrainerNotificationSession

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

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

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

    • canRegisterForBallotConstrainerNotifications

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

    • reliableBallotConstrainerNotifications

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

    • unreliableBallotConstrainerNotifications

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

    • acknowledgeBallotConstrainerNotification

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

    • registerForNewBallotConstrainers

      void registerForNewBallotConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new ballot constrainers. BallotConstrainerReceiver.newBallotConstrainers() is invoked when a new BallotConstrainer appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBallotConstrainers

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

    • registerForChangedBallotConstrainer

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

    • registerForDeletedBallotConstrainers

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

    • registerForDeletedBallotConstrainer

      void registerForDeletedBallotConstrainer(Id ballotConstrainerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted ballot constrainer. BallotConstrainerReceiver.deletedBallotConstrainers() is invoked when the specified ballot constrainer is deleted or removed from this polls.
      Parameters:
      ballotConstrainerId - the Id of the BallotConstrainer to monitor
      Throws:
      NullArgumentException - ballotConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.