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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DirectionQuery can be retrieved from this session and assigned to this Cookbook to create a virtual collection of Directions. The directions may be sequenced using the DirectionSearchOrder from this session.

This Cookbook has a default query that matches any direction and a default search order that specifies no sequencing. The queries may be examined using a DirectionQueryInspector. The query may be modified by converting the inspector back to a DirectionQuery.

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.
MethodcanManageSmartOubiliettes
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart cook book management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDirectionQuery
Description

Gets a direction query.

Returnosid.recipe.DirectionQuerythe direction query
CompliancemandatoryThis method must be implemented.
MethodgetDirectionSearchOrder
Description

Gets a direction search order.

Returnosid.recipe.DirectionSearchOrderthe direction search order
CompliancemandatoryThis method must be implemented.
MethodapplyDirectionQuery
Description

Applies a direction query to this cookbook.

Parametersosid.recipe.DirectionQuerydirectionQuerythe direction query
ErrorsNULL_ARGUMENT directionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED directionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecDirectionQuery
Description

Gets a direction query inspector for this cookbook.

Returnosid.recipe.DirectionQueryInspectorthe direction query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyDirectionSequencing
Description

Applies a direction search order to this cookbook.

Parametersosid.recipe.DirectionSearchOrderdirectionSearchOrderthe direction search order
ErrorsNULL_ARGUMENT directionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED directionSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDirectionQueryFromInspector
Description

Gets a direction query from an inspector.

Parametersosid.recipe.DirectionQueryInspectordirectionQueryInspectora direction query inspector
Returnosid.recipe.DirectionQuerythe direction query
ErrorsNULL_ARGUMENT directionQueryInspector is null
UNSUPPORTED directionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.