Interface ObjectiveReceiver

All Superinterfaces:
OsidReceiver
public interface ObjectiveReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfObjectives(Id notificationId, IdList objectiveIds)
    The callback for notifications of changes to children of objective hierarchy nodes.
    void
    changedObjectives(Id notificationId, IdList objectiveIds)
    The callback for notification of updated objectives.
    void
    deletedObjectives(Id notificationId, IdList objectiveIds)
    The callback for notification of deleted objectives.
    void
    newObjectives(Id notificationId, IdList objectiveIds)
    The callback for notifications of new objectives.

    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

    • newObjectives

      void newObjectives(Id notificationId, IdList objectiveIds)
      The callback for notifications of new objectives.
      Parameters:
      notificationId - the notification Id
      objectiveIds - the Ids of the new Objectives
      Compliance:
      mandatory - This method must be implemented.

    • changedObjectives

      void changedObjectives(Id notificationId, IdList objectiveIds)
      The callback for notification of updated objectives.
      Parameters:
      notificationId - the notification Id
      objectiveIds - the Ids of the updated Objectives
      Compliance:
      mandatory - This method must be implemented.

    • deletedObjectives

      void deletedObjectives(Id notificationId, IdList objectiveIds)
      The callback for notification of deleted objectives.
      Parameters:
      notificationId - the notification Id
      objectiveIds - the Ids of the deleted Objectives
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfObjectives

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