Interface ActivityNotificationSession

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

This session defines methods to receive notifications on adds/changes to Activities in this Business . This also includes existing activities that may appear or disappear due to changes in the Business 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 ActivityLookupSession .

  • Method Details

    • getBusinessId

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

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      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.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include activities in catalogs which are children of this catalog in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this business 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 appears in this business.
      Throws:
      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 in this business is changed.
      Throws:
      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 in this business 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 deleted or removed from this business.
      Throws:
      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.deletedActivities() is invoked when the specified activity is deleted or removed from this business.
      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.

    • registerForChangedActivityHierarchy

      void registerForChangedActivityHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated activity hierarchy structure. ActivityReceiver.changedChildOfActivitiess() is invoked when a node experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActivityHierarchyForAncestors

      void registerForChangedActivityHierarchyForAncestors(Id activityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated activity hierarchy structure. ActivityReceiver.changedChildOfActitivities() is invoked when the specified node or any of its ancestors experiences a change in its children.
      Parameters:
      activityId - the Id of the Activity node to monitor
      Throws:
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActivityHierarchyForDescendants

      void registerForChangedActivityHierarchyForDescendants(Id activityId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated activity hierarchy structure. ActivityReceiver.changedChildOfActivities() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      activityId - the Id of the Activity node to monitor
      Throws:
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.