Interface StepProcessorEnablerNotificationSession

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

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

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

    • canRegisterForStepProcessorEnablerNotifications

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

    • reliableStepProcessorEnablerNotifications

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

    • unreliableStepProcessorEnablerNotifications

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

    • acknowledgeStepProcessorEnablerNotification

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

    • registerForNewStepProcessorEnablers

      void registerForNewStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new step processor enablers. StepProcessorEnablerReceiver.newStepProcessorEnablers() is invoked when a new StepProcessorEnabler appears in this office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStepProcessorEnablers

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

    • registerForChangedStepProcessorEnabler

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

    • registerForDeletedStepProcessorEnablers

      void registerForDeletedStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted step processor enablers. StepProcessorEnablerReceiver.deletedStepProcessorEnablers() is invoked when a step 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.

    • registerForDeletedStepProcessorEnabler

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