Interface ActivityNotificationSession

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

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

  • Method Details

    • getObjectiveBankId

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

    • getObjectiveBank

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

    • canRegisterForActivityNotifications

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

    • useFederatedObjectiveBankView

      void useFederatedObjectiveBankView()
      Federates the view for methods in this session. A federated view will include notifications for activities in objective banks which are children of this objective bank in the objective bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedObjectiveBankView

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

    • reliableActivityNotifications

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

    • unreliableActivityNotifications

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

    • acknowledgeActivityNotification

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

    • registerForNewActivities

      void registerForNewActivities() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new activities. ActivityReceiver.newActivities() is invoked when a new activity is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewActivitiesForObjective

      void registerForNewActivitiesForObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new activities for the given objective. ActivityReceiver.newActivities() is invoked when a new activity is created.
      Parameters:
      objectiveId - the Id of the Activity to monitor
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActivities

      void registerForChangedActivities() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated activities. ActivityReceiver.changedActivities() is invoked when an activity is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActivitiesForObjective

      void registerForChangedActivitiesForObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated activities. ActivityReceiver.changedActivities() is invoked when an activity is changed.
      Parameters:
      objectiveId - the Id of the Objective to monitor
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActivity

      void registerForChangedActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated activity. ActivityReceiver.changedActivities() is invoked when the specified activity is changed.
      Parameters:
      activityId - the Id of the Activity to monitor
      Throws:
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedActivities

      void registerForDeletedActivities() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted activities. ActivityReceiver.deletedActivities() is invoked when an activity is removed from this objective bank.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedActivitiesForObjective

      void registerForDeletedActivitiesForObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted activities. ActivityReceiver.deletedActivities() is invoked when an activity is removed from this objective bank.
      Parameters:
      objectiveId - the Id of the Objective to monitor
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedActivity

      void registerForDeletedActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted activity. ActivityReceiver.changedActivities() is invoked when the specified activity is removed from this objective bank.
      Parameters:
      activityId - the Id of the Activity to monitor
      Throws:
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.