Interface StepProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to StepProcessor objects in this Office . This also includes existing StepProcessors 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 StepProcessorLookupSession .

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

    • canRegisterForStepProcessorNotifications

      boolean canRegisterForStepProcessorNotifications()
      Tests if this user can register for StepProcessor 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 in office 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.

    • reliableStepProcessorNotifications

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

    • unreliableStepProcessorNotifications

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

    • acknowledgeStepProcessorNotification

      void acknowledgeStepProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a step 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.

    • registerForNewStepProcessors

      void registerForNewStepProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new step processors. StepProcessorReceiver.newStepProcessors() is invoked when a new StepProcessor appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStepProcessors

      void registerForChangedStepProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated office. StepProcessorReceiver.changedStepProcessors() is invoked when a step processor in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStepProcessor

      void registerForChangedStepProcessor(Id stepProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated step processor. ProvisionableReceiver.changedStepProcessors() is invoked when the specified step processor in this office is changed.
      Parameters:
      stepProcessorId - the Id of the StepProcessor to monitor
      Throws:
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedStepProcessors

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

    • registerForDeletedStepProcessor

      void registerForDeletedStepProcessor(Id stepProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted step processor. StepProcessorReceiver.deletedStepProcessors() is invoked when the specified step processor is deleted or removed from this office.
      Parameters:
      stepProcessorId - the Id of the StepProcessor to monitor
      Throws:
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.