Interface | osid.recipe.DirectionLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving directions. This lookup session defines several views:
The methods Directions may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of 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 | canLookupDirections | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDirectionView | ||
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 | usePlenaryDirectionView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 retrievals to this cook book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDirection | ||
Description |
Gets the | ||
Parameters | osid.id.Id | directionId | the Id of the Direction to retrieve |
Return | osid.recipe.Direction | the returned Direction | |
Errors | NOT_FOUND | no Direction found with 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 | getDirectionsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | directionIds | the list of Ids to retrieve |
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | directionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | directionGenusType | a direction genus type |
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | NULL_ARGUMENT | directionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | directionGenusType | a direction genus type |
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | NULL_ARGUMENT | directionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | directionRecordType | a direction record type |
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | NULL_ARGUMENT | directionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionsForRecipe | ||
Description |
Gets a | ||
Parameters | osid.id.Id | recipeId | a recipe Id |
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | NULL_ARGUMENT | recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirections | ||
Description |
Gets all directions. | ||
Return | osid.recipe.DirectionList | the returned Direction list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |