Interface | osid.recipe.DirectionSmartCookbookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 | canManageSmartOubiliettes | ||
Description |
Tests if this user can manage smart oubiliettes. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart cook book management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionQuery | ||
Description |
Gets a direction query. | ||
Return | osid.recipe.DirectionQuery | the direction query | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionSearchOrder | ||
Description |
Gets a direction search order. | ||
Return | osid.recipe.DirectionSearchOrder | the direction search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyDirectionQuery | ||
Description |
Applies a direction query to this cookbook. | ||
Parameters | osid.recipe.DirectionQuery | directionQuery | the direction query |
Errors | NULL_ARGUMENT | directionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | directionQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspecDirectionQuery | ||
Description |
Gets a direction query inspector for this cookbook. | ||
Return | osid.recipe.DirectionQueryInspector | the direction query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyDirectionSequencing | ||
Description |
Applies a direction search order to this cookbook. | ||
Parameters | osid.recipe.DirectionSearchOrder | directionSearchOrder | the direction search order |
Errors | NULL_ARGUMENT | directionSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | directionSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionQueryFromInspector | ||
Description |
Gets a direction query from an inspector. | ||
Parameters | osid.recipe.DirectionQueryInspector | directionQueryInspector | a direction query inspector |
Return | osid.recipe.DirectionQuery | the direction query | |
Errors | NULL_ARGUMENT | directionQueryInspector is null | |
UNSUPPORTED | directionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |