Interface DocetReceiver

All Superinterfaces:
OsidReceiver
public interface DocetReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedDocets(Id notificationId, IdList docetIds)
    The callback for notification of updated docets.
    void
    deletedDocets(Id notificationId, IdList docetIds)
    the callback for notification of deleted docets.
    void
    newDocets(Id notificationId, IdList docetIds)
    The callback for notifications of new docets.

    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

    • newDocets

      void newDocets(Id notificationId, IdList docetIds)
      The callback for notifications of new docets.
      Parameters:
      notificationId - the notification Id
      docetIds - the Ids of the new Docets
      Compliance:
      mandatory - This method must be implemented.

    • changedDocets

      void changedDocets(Id notificationId, IdList docetIds)
      The callback for notification of updated docets.
      Parameters:
      notificationId - the notification Id
      docetIds - the Ids of the updated Docets
      Compliance:
      mandatory - This method must be implemented.

    • deletedDocets

      void deletedDocets(Id notificationId, IdList docetIds)
      the callback for notification of deleted docets.
      Parameters:
      notificationId - the notification Id
      docetIds - the Ids of the registered Docets
      Compliance:
      mandatory - This method must be implemented.