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

This session defines methods to receive notifications on adds/changes to Direction objects in this Cookbook. 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.

The two views defined in this session correspond to the views in the DirectionLookupSession.

MethodgetCookbookId
Description

Gets the Cookbook Id associated with this session.

Returnosid.id.Idthe Cookbook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCookbook
Description

Gets the Cookbook associated with this session.

Returnosid.recipe.Cookbookthe cookbook
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForDirectionNotifications
Description

Tests if this user can register for Direction 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.
MethoduseFederatedCookbookView
Description

Federates the view for methods in this session. A federated view will include directions in cook books which are children of this cook book in the cook book hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCookbookView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this cook book only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewDirections
Description

Register for notifications of new directions. DirectionReceiver.newDirections() is invoked when a new Direction appears in this cookbook.

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

Register for notifications of new directions related to the given recipe. DirectionReceiver.newDirections() is invoked when a new Direction appears in this cookbook.

Parametersosid.id.IdrecipeIdthe Id of the Recipe to monitor
ErrorsNULL_ARGUMENT recipeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDirections
Description

Registers for notification of updated directions. DirectionReceiver.changedDirections() is invoked when a direction in this cook book is changed.

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

Registers for notification of updated directions related to the given recipe. DirectionReceiver.changedDirections() is invoked when a direction related to the recipe in this cook book is changed.

Parametersosid.id.IdrecipeIdthe Id of the Recipe to monitor
ErrorsNULL_ARGUMENT recipeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDirection
Description

Registers for notification of an updated direction. DirectionReceiver.changedDirections() is invoked when the specified direction in this cook book is changed.

Parametersosid.id.IddirectionIdthe Id of the Direction to monitor
ErrorsNOT_FOUNDa direction was not found in this cook book identified by the given Id
NULL_ARGUMENT directionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDirections
Description

Registers for notification of deleted directions. DirectionReceiver.deletedDirection() is invoked when a direction is deleted or removed from this cookbook.

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

Registers for notification of deleted direction for a recipe. DirectionReceiver.deletedDirections() is invoked when the related direction is deleted or removed from this cookbook.

Parametersosid.id.IdrecipeIdthe Id of the Recipe to monitor
ErrorsNULL_ARGUMENT recipeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDirection
Description

Registers for notification of a deleted direction. DirectionReceiver.deletedDirections() is invoked when the specified direction is deleted or removed from this cookbook.

Parametersosid.id.IddirectionIdthe Id of the Direction to monitor
ErrorsNOT_FOUNDa direction was not found identified by the given Id
NULL_ARGUMENT directionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.