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

This session provides methods for searching among Direction objects. The search query is constructed using the DirectionQuery.

This session defines views that offer differing behaviors for searching.

  • federated cook book view: searches include directions in cook books of which this cook book is an ancestor in the cook book hierarchy
  • isolated cook book view: searches are restricted to directions in this cook books

Directions may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchDirections
Description

Tests if this user can perform Direction lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCookbookView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCookbookView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this cook book only.

CompliancemandatoryThis method is must be implemented.
MethodgetDirectionQuery
Description

Gets a direction query.

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

Gets a list of Directions matching the given direction query.

Parametersosid.recipe.DirectionQuerydirectionQuerythe direction query
Returnosid.recipe.DirectionListthe returned DirectionList
ErrorsNULL_ARGUMENT directionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED directionQuery is not of this service
CompliancemandatoryThis method must be implemented.