Interface RelationshipReceiver

All Superinterfaces:
OsidReceiver
public interface RelationshipReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedRelationships(Id notificationId, IdList relationshipIds)
    The callback for notification of updated relationships.
    void
    deletedRelationships(Id notificationId, IdList relationshipIds)
    the callback for notification of deleted relationships.
    void
    newRelationships(Id notificationId, IdList relationshipIds)
    The callback for notifications of new relationships.

    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

    • newRelationships

      void newRelationships(Id notificationId, IdList relationshipIds)
      The callback for notifications of new relationships.
      Parameters:
      notificationId - the notification Id
      relationshipIds - the Ids of the new Relationships
      Compliance:
      mandatory - This method must be implemented.

    • changedRelationships

      void changedRelationships(Id notificationId, IdList relationshipIds)
      The callback for notification of updated relationships.
      Parameters:
      notificationId - the notification Id
      relationshipIds - the Ids of the updated Relationships
      Compliance:
      mandatory - This method must be implemented.

    • deletedRelationships

      void deletedRelationships(Id notificationId, IdList relationshipIds)
      the callback for notification of deleted relationships.
      Parameters:
      notificationId - the notification Id
      relationshipIds - the Ids of the deleted Relationships
      Compliance:
      mandatory - This method must be implemented.