Interface ProcessProcessorEnablerNotificationSession

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

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

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

    • canRegisterForProcessProcessorEnablerNotifications

      boolean canRegisterForProcessProcessorEnablerNotifications()
      Tests if this user can register for ProcessProcessorEnabler 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 processor enablers 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.

    • reliableProcessProcessorEnablerNotifications

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

    • unreliableProcessProcessorEnablerNotifications

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

    • acknowledgeProcessProcessorEnablerNotification

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

    • registerForNewProcessProcessorEnablers

      void registerForNewProcessProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new process processor enablers. ProcessProcessorEnablerReceiver.newProcessProcessorEnablers() is invoked when a new ProcessProcessorEnabler appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessProcessorEnablers

      void registerForChangedProcessProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated process processor enablers. ProcessProcessorEnablerReceiver.changedProcessProcessorEnablers() is invoked when a ProcessProcessorEnabler in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProcessProcessorEnabler

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

    • registerForDeletedProcessProcessorEnablers

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

    • registerForDeletedProcessProcessorEnabler

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