org.osid.offering

Interface CatalogueReceiver

All Superinterfaces:

OsidReceiver

public interface CatalogueReceiver
extends OsidReceiver

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changedCatalogues(IdList catalogueIds) The callback for notification of updated catalogues.
void	deletedAncestorCatalogue(Id catalogueId, Id ancestorId) The callback for notifications of deleted ancestors of a catalogue.
void	deletedCatalogues(IdList catalogueIds) the callback for notification of deleted catalogues.
void	deletedDescendantCatalogue(Id catalogueId, Id descendantId) The callback for notifications of deleted descendants of a catalogue.
void	newAncestorCatalogue(Id catalogueId, Id ancestorId) The callback for notifications of new ancestors of a catalogue.
void	newCatalogues(IdList catalogueIds) The callback for notifications of new catalogues.
void	newDescendantCatalogue(Id catalogueId, Id descendantId) The callback for notifications of new descendant of a catalogue.
void	restructuredCatalogueHierarchy() The callback for notifications of changes to a catalogue hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newCatalogues

void newCatalogues(IdList catalogueIds)

The callback for notifications of new catalogues.

Parameters:

catalogueIds - the Ids of the new Catalogues

Compliance:

mandatory - This method must be implemented.

newAncestorCatalogue

void newAncestorCatalogue(Id catalogueId,
                        Id ancestorId)

The callback for notifications of new ancestors of a catalogue.

Parameters:

catalogueId - the Id of the registered Catalogue

ancestorId - the Id of the new ancestor catalogue

Compliance:

mandatory - This method must be implemented.

newDescendantCatalogue

void newDescendantCatalogue(Id catalogueId,
                          Id descendantId)

The callback for notifications of new descendant of a catalogue.

Parameters:

catalogueId - the Id of the registered Catalogue

descendantId - the Id of the new descendant catalogue

Compliance:

mandatory - This method must be implemented.

changedCatalogues

void changedCatalogues(IdList catalogueIds)

The callback for notification of updated catalogues.

Parameters:

catalogueIds - the Ids of the updated Catalogues

Compliance:

mandatory - This method must be implemented.

deletedCatalogues

void deletedCatalogues(IdList catalogueIds)

the callback for notification of deleted catalogues.

Parameters:

catalogueIds - the Ids of the registered Catalogues

Compliance:

mandatory - This method must be implemented.

deletedAncestorCatalogue

void deletedAncestorCatalogue(Id catalogueId,
                            Id ancestorId)

The callback for notifications of deleted ancestors of a catalogue.

Parameters:

catalogueId - the Id of the registered Catalogue

ancestorId - the Id of the removed ancestor catalogue

Compliance:

mandatory - This method must be implemented.

deletedDescendantCatalogue

void deletedDescendantCatalogue(Id catalogueId,
                              Id descendantId)

The callback for notifications of deleted descendants of a catalogue.

Parameters:

catalogueId - the Id of the registered Catalogue

descendantId - the Id of the deleted descendant catalogue

Compliance:

mandatory - This method must be implemented.

restructuredCatalogueHierarchy

void restructuredCatalogueHierarchy()

The callback for notifications of changes to a catalogue hierarchy where the hierarchy needs to refreshed.

Compliance:

mandatory - This method must be implemented.