Interface StepEnablerNotificationSession

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

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

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

    • canRegisterForStepEnablerNotifications

      boolean canRegisterForStepEnablerNotifications()
      Tests if this user can register for StepEnabler 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 step 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.

    • reliableStepEnablerNotifications

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

    • unreliableStepEnablerNotifications

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

    • acknowledgeStepEnablerNotification

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

    • registerForNewStepEnablers

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

    • registerForChangedStepEnablers

      void registerForChangedStepEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated step enablers. StepEnablerReceiver.changedStepEnablers() is invoked when a StepEnabler in this office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedStepEnabler

      void registerForChangedStepEnabler(Id stepEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated step enabler. StepEnablerReceiver.changedStepEnablers() is invoked when the specified StepEnabler in this office is changed.
      Parameters:
      stepEnablerId - the Id of the StepEnabler to monitor
      Throws:
      NullArgumentException - stepEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedStepEnablers

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

    • registerForDeletedStepEnabler

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