Interface ProcessNotificationSession

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

This session defines methods to receive notifications on adds/changes to Processes in this Office . This also includes existing process 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 ProcessLookupSession .

  • 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.

    • canRegisterForProcessNotifications

      boolean canRegisterForProcessNotifications()
      Tests if this user can register for Process 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 process 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.

    • reliableProcessNotifications

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

    • unreliableProcessNotifications

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

    • acknowledgeProcessNotification

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

    • registerForNewProcesses

      void registerForNewProcesses() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new processes. ProcessReceiver.newProcesses() is invoked when a new Process appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcesses

      void registerForChangedProcesses() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated processes. ProcessReceiver.changedProcesses() is invoked when a process in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcess

      void registerForChangedProcess(Id processId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated process. ProcessReceiver.changedProcesses() is invoked when the specified process in this office is changed.
      Parameters:
      processId - the Id of the Process to monitor
      Throws:
      NullArgumentException - processId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcesses

      void registerForDeletedProcesses() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted processes. ProcessReceiver.deletedProcesses() is invoked when a process is deleted or removed from this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcess

      void registerForDeletedProcess(Id processId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted process. ProcessReceiver.deletedProcesses() is invoked when the specified process is deleted or removed from this office.
      Parameters:
      processId - the Id of the Process to monitor
      Throws:
      NullArgumentException - processId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.