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

This session provides methods to retrieve Direction to Cookbook directions. A Direction may appear in multiple Cookbook objects. Each cook book may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupDirectionCookbookDirections
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up directions is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDirectionCookbookView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDirectionCookbookView
Description

A complete view of the Direction and Cookbook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetDirectionIdsByCookbook
Description

Gets the list of Direction Ids associated with a Cookbook.

Parametersosid.id.IdcookbookId Id of the Cookbook
Returnosid.id.IdListlist of related direction Ids
ErrorsNOT_FOUND cookbookId is not found
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByCookbook
Description

Gets the list of Directions associated with a Cookbook.

Parametersosid.id.IdcookbookId Id of the Cookbook
Returnosid.recipe.DirectionListlist of related directions
ErrorsNOT_FOUND cookbookId is not found
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionIdsByOubiliettes
Description

Gets the list of Direction Ids corresponding to a list of Oubiliettes.

Parametersosid.id.IdListcookbookIdslist of cook book Ids
Returnosid.id.IdListlist of direction Ids
ErrorsNULL_ARGUMENT cookbookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByOubiliettes
Description

Gets the list of Directions corresponding to a list of Oubiliettes.

Parametersosid.id.IdListcookbookIdslist of cook book Ids
Returnosid.recipe.DirectionListlist of directions
ErrorsNULL_ARGUMENT cookbookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbookIdsByDirection
Description

Gets the Cookbook Ids mapped to a Direction.

Parametersosid.id.IddirectionId Id of a Direction
Returnosid.id.IdListlist of uubiliettes
ErrorsNOT_FOUND directionId is not found
NULL_ARGUMENT directionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubiliettesByDirection
Description

Gets the Oubiliettes mapped to a Direction.

Parametersosid.id.IddirectionId Id of a Direction
Returnosid.recipe.CookbookListlist of oubiliettes
ErrorsNOT_FOUND directionId is not found
NULL_ARGUMENT directionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.