Interface CandidateNotificationSession

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

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

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForCandidateNotifications

      boolean canRegisterForCandidateNotifications()
      Tests if this user can register for Candidate 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 candidates 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.

    • reliableCandidateNotifications

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

    • unreliableCandidateNotifications

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

    • acknowledgeCandidateNotification

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

    • registerForNewCandidates

      void registerForNewCandidates() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new candidates. CandidateReceiver.newCandidates() is invoked when a new Candidate is appears in this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCandidatesForResource

      void registerForNewCandidatesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a new candidate for the given resource. CandidateReceiver.newCandidates() is invoked when the specified candidate is created in this polls.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewCandidatesForRace

      void registerForNewCandidatesForRace(Id raceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a new candidate for the given race. CandidateReceiver.newCandidates() is invoked when the specified candidate is created in this polls.
      Parameters:
      raceId - the Id of the race to monitor
      Throws:
      NullArgumentException - raceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCandidates

      void registerForChangedCandidates() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated candidates. CandidateReceiver.changedCandidates() is invoked when a candidate in this polls is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCandidatesForResource

      void registerForChangedCandidatesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated candidate for the given resource. CandidateReceiver.changedCandidates() is invoked when the specified candidate is updated in this polls.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCandidatesForRace

      void registerForChangedCandidatesForRace(Id raceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated candidate for the given race. CandidateReceiver.changedCandidates() is invoked when the specified candidate is updated in this polls.
      Parameters:
      raceId - the Id of the race to monitor
      Throws:
      NullArgumentException - raceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCandidate

      void registerForChangedCandidate(Id candidateId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated candidate. CandidateReceiver.changedCandidates() is invoked when the specified candidate in this polls is changed.
      Parameters:
      candidateId - the Id of the Candidate to monitor
      Throws:
      NullArgumentException - candidateId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCandidates

      void registerForDeletedCandidates() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted candidates. CandidateReceiver.deletedCandidates() is invoked when a candidate is deleted or removed from this polls.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCandidatesForResource

      void registerForDeletedCandidatesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted candidate for the given resource. CandidateReceiver.deletedCandidates() is invoked when the specified candidate is deleted or removed from this polls.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCandidatesForRace

      void registerForDeletedCandidatesForRace(Id raceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted candidate for the given race. CandidateReceiver.deletedCandidates() is invoked when the specified candidate is deleted or removed from this polls.
      Parameters:
      raceId - the Id of the race to monitor
      Throws:
      NullArgumentException - raceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCandidate

      void registerForDeletedCandidate(Id candidateId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted candidate. CandidateReceiver.deletedCandidates() is invoked when the specified candidate is deleted or removed from this polls.
      Parameters:
      candidateId - the Id of the Candidate to monitor
      Throws:
      NullArgumentException - candidateId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.