Interface ConferralNotificationSession

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

This session defines methods to receive notifications on adds/changes to Conferrals . 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.

  • Method Details

    • getAcademyId

      Id getAcademyId()
      Gets the Academy Id associated with this session.
      Returns:
      the Academy Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getAcademy

      Academy getAcademy() throws OperationFailedException, PermissionDeniedException
      Gets the Academy associated with this session.
      Returns:
      the academy
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForConferralNotifications

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

    • useFederatedAcademyView

      void useFederatedAcademyView()
      Federates the view for methods in this session. A federated view will include conferrals in academies which are children of this academy in the academy hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAcademyView

      void useIsolatedAcademyView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableConferralNotifications

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

    • unreliableConferralNotifications

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

    • acknowledgeConferralNotification

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

    • registerForNewConferrals

      void registerForNewConferrals() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new conferrals. ConferralReceiver.newConferrals() is invoked when a new Conferral is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewConferralsForRecipient

      void registerForNewConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new conferrals for the given recipient Id . ConferralReceiver.newConferrals() is invoked when a new Conferral is created.
      Parameters:
      resourceId - the Id of the recipient to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewConferralsForAward

      void registerForNewConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new conferrals for the given reference Id . ConferralReceiver.newConferrals() is invoked when a new Conferral is created.
      Parameters:
      awardId - the Id of the award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewConferralsByConvocation

      void registerForNewConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new conferrals for the given convocation Id . ConferralReceiver.newConferrals() is invoked when a new Conferral is created.
      Parameters:
      convocationId - the Id of the convocation to monitor
      Throws:
      NullArgumentException - convocationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedConferrals

      void registerForChangedConferrals() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated conferrals. ConferralReceiver.changedConferrals() is invoked when a conferral is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedConferralsForRecipient

      void registerForChangedConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed conferrals for the given recipient Id . ConferralReceiver.changedConferrals() is invoked when a Conferral for the recipient is changed.
      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.

    • registerForChangedConferralsForAward

      void registerForChangedConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed conferrals for the given award Id . ConferralReceiver.changedConferrals() is invoked when a Conferral for the award is changed.
      Parameters:
      awardId - the Id of the award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedConferralsByConvocation

      void registerForChangedConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of changed conferrals for the given award Id . ConferralReceiver.changedConferrals() is invoked when a Conferral for the convocation is changed.
      Parameters:
      convocationId - the Id of the convocation to monitor
      Throws:
      NullArgumentException - convocationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedConferral

      void registerForChangedConferral(Id conferralId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated conferral. ConferralReceiver.changedConferrals() is invoked when the specified conferral is changed.
      Parameters:
      conferralId - the Id of the Conferral to monitor
      Throws:
      NullArgumentException - conferralId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedConferrals

      void registerForDeletedConferrals() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted conferrals. ConferralReceiver.deletedConferrals() is invoked when a conferral is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedConferralsForRecipient

      void registerForDeletedConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted conferrals for the given recipient Id . ConferralReceiver.deletedConferrals() is invoked when a Conferral for the recipient is deleted.
      Parameters:
      resourceId - the Id of the recipient to monitor
      Throws:
      NullArgumentException - recipientId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedConferralsForAward

      void registerForDeletedConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted conferrals for the given award Id . ConferralReceiver.deletedConferrals() is invoked when a Conferral for the award is deleted.
      Parameters:
      awardId - the Id of the award to monitor
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedConferralsByConvocation

      void registerForDeletedConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted conferrals for the given convocation Id . ConferralReceiver.deletedConferrals() is invoked when a Conferral for the convocation is deleted.
      Parameters:
      convocationId - the Id of the convocation to monitor
      Throws:
      NullArgumentException - convocationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedConferral

      void registerForDeletedConferral(Id conferralId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted conferral. ConferralReceiver.deletedConferrals() is invoked when the specified conferral is deleted.
      Parameters:
      conferralId - the Id of the Conferral to monitor
      Throws:
      NullArgumentException - conferralId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.