Interface CanonicalUnitReceiver

All Superinterfaces:
OsidReceiver
public interface CanonicalUnitReceiver extends OsidReceiver

The canonical unit receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted canonical units.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
    The callback for notifications of updated canonical units.
    void
    deletedCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
    the callback for notification of deleted canonical units.
    void
    newCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
    The callback for notifications of new canonical units.

    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

    • newCanonicalUnits

      void newCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
      The callback for notifications of new canonical units.
      Parameters:
      notificationId - the notification Id
      canonicalUnitIds - the Ids of the new canonical units
      Compliance:
      mandatory - This method must be implemented.

    • changedCanonicalUnits

      void changedCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
      The callback for notifications of updated canonical units.
      Parameters:
      notificationId - the notification Id
      canonicalUnitIds - the Ids of the updated canonical units
      Compliance:
      mandatory - This method must be implemented.

    • deletedCanonicalUnits

      void deletedCanonicalUnits(Id notificationId, IdList canonicalUnitIds)
      the callback for notification of deleted canonical units.
      Parameters:
      notificationId - the notification Id
      canonicalUnitIds - the Ids of the deleted canonical units
      Compliance:
      mandatory - This method must be implemented.