Interface WorkNotificationSession

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

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

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canRegisterForWorkNotifications

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

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include works in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

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

    • reliableWorkNotifications

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

    • unreliableWorkNotifications

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

    • acknowledgeWorkNotification

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

    • registerForNewWorks

      void registerForNewWorks() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new works. WorkReceiver.newWorks() is invoked when a new Work appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedWorks

      void registerForChangedWorks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated works. WorkReceiver.changedWorks() is invoked when a work in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedWork

      void registerForChangedWork(Id workId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated work. WorkReceiver.changedWorks() is invoked when the specified work in this office is changed.
      Parameters:
      workId - the Id of the Work to monitor
      Throws:
      NullArgumentException - workId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedWorks

      void registerForDeletedWorks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted works. WorkReceiver.deletedWorks() is invoked when a work is deleted or removed from this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedWork

      void registerForDeletedWork(Id workId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted work. WorkReceiver.deletedWorks() is invoked when the specified work is deleted or removed from this office.
      Parameters:
      workId - the Id of the Work to monitor
      Throws:
      NullArgumentException - workId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.