org.osid.recipe

Interface CookbookReceiver

All Superinterfaces:

OsidReceiver

public interface CookbookReceiver
extends OsidReceiver

The cook book receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Cookbook objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedCookbooks(IdList cookbookIds) The callback for notification of updated cook books.
void	deletedAncestorCookbook(Id cookbookId, Id ancestorId) The callback for notifications of deleted ancestors of a cookbook.
void	deletedCookbooks(IdList cookbookIds) the callback for notification of deleted cook books.
void	deletedDescendantCookbook(Id cookbookId, Id descendantId) The callback for notifications of deleted descendants of a cookbook.
void	newAncestorCookbook(Id cookbookId, Id ancestorId) The callback for notifications of new ancestors of a cookbook.
void	newCookbooks(IdList cookbookIds) The callback for notifications of new cook books.
void	newDescendantCookbook(Id cookbookId, Id descendantId) The callback for notifications of new descendant of a cookbook.
void	restructuredCookbookHierarchy() The callback for notifications of changes to a cookbook hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newCookbooks

void newCookbooks(IdList cookbookIds)

The callback for notifications of new cook books.

Parameters:

cookbookIds - the Ids of the new Cookbooks

Compliance:

mandatory - This method must be implemented.

newAncestorCookbook

void newAncestorCookbook(Id cookbookId,
                       Id ancestorId)

The callback for notifications of new ancestors of a cookbook.

Parameters:

cookbookId - the Id of the registered Cookbook

ancestorId - the Id of the new ancestor cookbook

Compliance:

mandatory - This method must be implemented.

newDescendantCookbook

void newDescendantCookbook(Id cookbookId,
                         Id descendantId)

The callback for notifications of new descendant of a cookbook.

Parameters:

cookbookId - the Id of the registered Cookbook

descendantId - the Id of the new descendant cookbook

Compliance:

mandatory - This method must be implemented.

changedCookbooks

void changedCookbooks(IdList cookbookIds)

The callback for notification of updated cook books.

Parameters:

cookbookIds - the Ids of the updated Cookbooks

Compliance:

mandatory - This method must be implemented.

deletedCookbooks

void deletedCookbooks(IdList cookbookIds)

the callback for notification of deleted cook books.

Parameters:

cookbookIds - the Ids of the registered Cookbooks

Compliance:

mandatory - This method must be implemented.

deletedAncestorCookbook

void deletedAncestorCookbook(Id cookbookId,
                           Id ancestorId)

The callback for notifications of deleted ancestors of a cookbook.

Parameters:

cookbookId - the Id of the registered Cookbook

ancestorId - the Id of the removed ancestor cookbook

Compliance:

mandatory - This method must be implemented.

deletedDescendantCookbook

void deletedDescendantCookbook(Id cookbookId,
                             Id descendantId)

The callback for notifications of deleted descendants of a cookbook.

Parameters:

cookbookId - the Id of the registered Cookbook

descendantId - the Id of the deleted descendant cookbook

Compliance:

mandatory - This method must be implemented.

restructuredCookbookHierarchy

void restructuredCookbookHierarchy()

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

Compliance:

mandatory - This method must be implemented.