Interface | osid.recipe.DirectionCookbookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupDirectionCookbookDirections | ||
Description |
Tests if this user can perform lookups of
direction/cook book mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up directions is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDirectionCookbookView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryDirectionCookbookView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDirectionIdsByCookbook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | cookbookId | Id of the Cookbook |
Return | osid.id.IdList | list of related direction Ids | |
Errors | NOT_FOUND | cookbookId is not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsByCookbook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | cookbookId | Id of the Cookbook |
Return | osid.recipe.DirectionList | list of related directions | |
Errors | NOT_FOUND | cookbookId is not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionIdsByOubiliettes | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | cookbookIds | list of cook book Ids |
Return | osid.id.IdList | list of direction Ids | |
Errors | NULL_ARGUMENT | cookbookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsByOubiliettes | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | cookbookIds | list of cook book Ids |
Return | osid.recipe.DirectionList | list of directions | |
Errors | NULL_ARGUMENT | cookbookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookIdsByDirection | ||
Description |
Gets the | ||
Parameters | osid.id.Id | directionId | Id of a Direction |
Return | osid.id.IdList | list of uubiliettes | |
Errors | NOT_FOUND | directionId is not found | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOubiliettesByDirection | ||
Description |
Gets the | ||
Parameters | osid.id.Id | directionId | Id of a Direction |
Return | osid.recipe.CookbookList | list of oubiliettes | |
Errors | NOT_FOUND | directionId is not found | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |