Interface StateReceiver

All Superinterfaces:
OsidReceiver
public interface StateReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedStates(Id notificationId, IdList stateIds)
    The callback for notification of updated states.
    void
    deletedStates(Id notificationId, IdList stateIds)
    the callback for notification of deleted states.
    void
    newStates(Id notificationId, IdList stateIds)
    The callback for notifications of new states.

    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

    • newStates

      void newStates(Id notificationId, IdList stateIds)
      The callback for notifications of new states.
      Parameters:
      notificationId - the notification Id
      stateIds - the Ids of the new States
      Compliance:
      mandatory - This method must be implemented.

    • changedStates

      void changedStates(Id notificationId, IdList stateIds)
      The callback for notification of updated states.
      Parameters:
      notificationId - the notification Id
      stateIds - the Ids of the updated States
      Compliance:
      mandatory - This method must be implemented.

    • deletedStates

      void deletedStates(Id notificationId, IdList stateIds)
      the callback for notification of deleted states.
      Parameters:
      notificationId - the notification Id
      stateIds - the Ids of the deleted States
      Compliance:
      mandatory - This method must be implemented.