Interface CommitmentEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to CommitmentEnabler objects in this Calendar . This also includes existing CommitmentEnablers that may appear or disappear due to changes in the Calendar 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 CommitmentEnablerLookupSession .

  • Method Details

    • getCalendarId

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

    • getCalendar

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

    • canRegisterForCommitmentEnablerNotifications

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

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include enablers in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

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

    • reliableCommitmentEnablerNotifications

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

    • unreliableCommitmentEnablerNotifications

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

    • acknowledgeCommitmentEnablerNotification

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

    • registerForNewCommitmentEnablers

      void registerForNewCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new commitment enablers. CommitmentEnablerReceiver.newCommitmentEnablers() is invoked when a new CommitmentEnabler appears in this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCommitmentEnablers

      void registerForChangedCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated calendar enablers. CommitmentEnablerReceiver.changedCommitmentEnablers() is invoked when a commitment enabler in this calendar is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCommitmentEnabler

      void registerForChangedCommitmentEnabler(Id commitmentEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated commitment enabler. CommitmentEnablerReceiver.changedCommitmentEnablers() is invoked when the specified commitment enabler in this calendar is changed.
      Parameters:
      commitmentEnablerId - the Id of the CommitmentEnabler to monitor
      Throws:
      NullArgumentException - commitmentEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCommitmentEnablers

      void registerForDeletedCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted commitment enablers. CommitmentEnablerReceiver.deletedCommitmentEnablers() is invoked when a commitment enabler is deleted or removed from this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCommitmentEnabler

      void registerForDeletedCommitmentEnabler(Id commitmentEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted commitment enabler. CommitmentEnablerReceiver.deletedCommitmentEnablers() is invoked when the specified commitment enabler is deleted or removed from this calendar.
      Parameters:
      commitmentEnablerId - the Id of the CommitmentEnabler to monitor
      Throws:
      NullArgumentException - commitmentEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.