Interface BallotConstrainerEnablerNotificationSession

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

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

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

    • canRegisterForBallotConstrainerEnablerNotifications

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

    • reliableBallotConstrainerEnablerNotifications

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

    • unreliableBallotConstrainerEnablerNotifications

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

    • acknowledgeBallotConstrainerEnablerNotification

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

    • registerForNewBallotConstrainerEnablers

      void registerForNewBallotConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new ballot constrainer enablers. BallotConstrainerEnablerReceiver.newBallotConstrainerEnablers() is invoked when a new BallotConstrainerEnabler appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBallotConstrainerEnablers

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

    • registerForChangedBallotConstrainerEnabler

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

    • registerForDeletedBallotConstrainerEnablers

      void registerForDeletedBallotConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted ballot constrainer enablers. BallotConstrainerEnablerReceiver.deletedBallotConstrainerEnablers() is invoked when a ballot 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.

    • registerForDeletedBallotConstrainerEnabler

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