OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.CookbookNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Cookbook objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

Notifications are triggered with changes to the Cookbook object itself. Adding and removing procedures result in notifications available from the notification session for procedures.

MethodcanRegisterForCookbookNotifications
Description

Tests if this user can register for Cookbook notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCookbooks
Description

Register for notifications of new cook books. CookbookReceiver.newCookbooks() is invoked when a new Cookbook is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCookbookAncestors
Description

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified cookbook. CookbookReceiver.newAncestorCookbook() is invoked when the specified cook book node gets a new ancestor.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook node to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCookbookDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified cookbook. CookbookReceiver.newDescendantCookbook() is invoked when the specified cook book node gets a new descendant.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook node to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCookbooks
Description

Registers for notification of updated cook books. CookbookReceiver.changedCookbook() is invoked when a cook book is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCookbook
Description

Registers for notification of an updated cookbook. CookbookReceiver.changedCookbooks() is invoked when the specified cook book is changed.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCookbooks
Description

Registers for notification of deleted cook books. CookbookReceiver.deletedCookbooks() is invoked when a cook book is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCookbook
Description

Registers for notification of a deleted cookbook. CookbookReceiver.deletedCookbooks() is invoked when the specified cook book is deleted.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCookbookAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified cook book CookbookReceiver.deletedAncestor() is invoked when the specified cook book node loses an ancestor.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCookbookDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified cookbook. CookbookReceiver.deletedDescendant() is invoked when the specified cook book node loses a descendant.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook to monitor
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.