Interface ProcessProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to ProcessProcessors in this Office . This also includes existing process processors that may appear or disappear due to changes in the Office hierarc hy, 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 ProcessProcessorLookupSession .

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

    • canRegisterForProcessProcessorNotifications

      boolean canRegisterForProcessProcessorNotifications()
      Tests if this user can register for ProcessProcessor 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 processors 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.

    • reliableProcessProcessorNotifications

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

    • unreliableProcessProcessorNotifications

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

    • acknowledgeProcessProcessorNotification

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

    • registerForNewProcessProcessors

      void registerForNewProcessProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new process processors. ProcessProcessorReceiver.newProcessProcessors() is invoked when a new ProcessProcessor appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessProcessors

      void registerForChangedProcessProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated process processors. ProcessProcessorReceiver.changedProcessProcessors() is invoked when a ProcessProcessor in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessProcessor

      void registerForChangedProcessProcessor(Id processProcessorId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated process processor. ProcessProcessorReceiver.changedProcessProcessors() is invoked when the specified ProcessProcessor in this office is changed.
      Parameters:
      processProcessorId - the Id of the ProcessProcessor to monitor
      Throws:
      NullArgumentException - processProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProcessProcessors

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

    • registerForDeletedProcessProcessor

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