Interface ChecklistReceiver

All Superinterfaces:
OsidReceiver
public interface ChecklistReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChecklists(IdList checklistIds)
    The callback for notification of updated checklists.
    void
    changedChildOfChecklists(Id notificationId, IdList checklistIds)
    The callback for notifications of changes to children of checklist hierarchy nodes.
    void
    deletedChecklists(IdList checklistIds)
    the callback for notification of deleted checklists.
    void
    newChecklists(IdList checklistIds)
    The callback for notifications of new checklists.

    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

    • newChecklists

      void newChecklists(IdList checklistIds)
      The callback for notifications of new checklists.
      Parameters:
      checklistIds - the Ids of the new Checklists
      Compliance:
      mandatory - This method must be implemented.

    • changedChecklists

      void changedChecklists(IdList checklistIds)
      The callback for notification of updated checklists.
      Parameters:
      checklistIds - the Ids of the updated Checklists
      Compliance:
      mandatory - This method must be implemented.

    • deletedChecklists

      void deletedChecklists(IdList checklistIds)
      the callback for notification of deleted checklists.
      Parameters:
      checklistIds - the Ids of the registered Checklists
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfChecklists

      void changedChildOfChecklists(Id notificationId, IdList checklistIds)
      The callback for notifications of changes to children of checklist hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      checklistIds - the Ids of the Checklists whose children have changed
      Compliance:
      mandatory - This method must be implemented.