Interface InstructionReceiver

All Superinterfaces:
OsidReceiver
public interface InstructionReceiver extends OsidReceiver

The instruction receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted instructions.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedInstructions(Id notificationId, IdList instructionIds)
    The callback for notification of updated instructions.
    void
    deletedInstructions(Id notificationId, IdList instructionIds)
    The callback for notification of deleted instructions.
    void
    newInstructions(Id notificationId, IdList instructionIds)
    The callback for notifications of new instructions.

    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

    • newInstructions

      void newInstructions(Id notificationId, IdList instructionIds)
      The callback for notifications of new instructions.
      Parameters:
      notificationId - the notification Id
      instructionIds - the Ids of the new Instructions
      Compliance:
      mandatory - This method must be implemented.

    • changedInstructions

      void changedInstructions(Id notificationId, IdList instructionIds)
      The callback for notification of updated instructions.
      Parameters:
      notificationId - the notification Id
      instructionIds - the Ids of the updated Instructions
      Compliance:
      mandatory - This method must be implemented.

    • deletedInstructions

      void deletedInstructions(Id notificationId, IdList instructionIds)
      The callback for notification of deleted instructions.
      Parameters:
      notificationId - the notification Id
      instructionIds - the Ids of the deleted Instructions
      Compliance:
      mandatory - This method must be implemented.