Interface StepReceiver

All Superinterfaces:
OsidReceiver
public interface StepReceiver extends OsidReceiver

The step receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Step objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedSteps(Id notificationId, IdList stepIds)
    The callback for notification of updated steps.
    void
    deletedSteps(Id notificationId, IdList stepIds)
    The callback for notification of deleted steps.
    void
    newSteps(Id notificationId, IdList stepIds)
    The callback for notifications of new steps.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newSteps

      void newSteps(Id notificationId, IdList stepIds)
      The callback for notifications of new steps.
      Parameters:
      notificationId - the notification Id
      stepIds - the Ids of the new Steps
      Compliance:
      mandatory - This method must be implemented.

    • changedSteps

      void changedSteps(Id notificationId, IdList stepIds)
      The callback for notification of updated steps.
      Parameters:
      notificationId - the notification Id
      stepIds - the Ids of the updated Steps
      Compliance:
      mandatory - This method must be implemented.

    • deletedSteps

      void deletedSteps(Id notificationId, IdList stepIds)
      The callback for notification of deleted steps.
      Parameters:
      notificationId - the notification Id
      stepIds - the Ids of the deleted Steps
      Compliance:
      mandatory - This method must be implemented.