Interface | osid.recipe.DirectionNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getCookbookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Cookbook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbook | ||
Description |
Gets the | ||
Return | osid.recipe.Cookbook | the cookbook | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForDirectionNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCookbookView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCookbookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this cook book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewDirections | ||
Description |
Register for notifications of new directions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewDirectionsForRecipe | ||
Description |
Register for notifications of new directions related to
the given recipe. | ||
Parameters | osid.id.Id | recipeId | the Id of the Recipe to monitor |
Errors | NULL_ARGUMENT | recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDirections | ||
Description |
Registers for notification of updated directions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDirectionsForRecipe | ||
Description |
Registers for notification of updated directions
related to the given recipe. | ||
Parameters | osid.id.Id | recipeId | the Id of the Recipe to monitor |
Errors | NULL_ARGUMENT | recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDirection | ||
Description |
Registers for notification of an updated direction.
| ||
Parameters | osid.id.Id | directionId | the Id of the Direction to monitor |
Errors | NOT_FOUND | a direction was not found in this cook book identified by the given
Id | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDirections | ||
Description |
Registers for notification of deleted directions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDirectionsForRecipe | ||
Description |
Registers for notification of deleted direction for a
recipe. | ||
Parameters | osid.id.Id | recipeId | the Id of the Recipe to monitor |
Errors | NULL_ARGUMENT | recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDirection | ||
Description |
Registers for notification of a deleted direction.
| ||
Parameters | osid.id.Id | directionId | the Id of the Direction to monitor |
Errors | NOT_FOUND | a direction was not found identified by the given Id | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |