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

This session defines methods for retrieving directions.

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
  • isolated cook book view: All direction methods in this session operate, retrieve and pertain to directions defined explicitly in the current cookbook. Using an isolated view is useful for managing Directions with the DirectionAdminSession.
  • federated cook book view: All direction lookup methods in this session operate, retrieve and pertain to all directions defined in this cook book and any other directions implicitly available in this cook book through cook book inheritence.

The methods useFederatedCookbookView() and useIsolatedCookbookView() behave as a radio group and one should be selected before invoking any lookup methods.

Directions may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Directions.

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.
MethodcanLookupDirections
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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDirectionView
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.
MethodusePlenaryDirectionView
Description

A complete view of the Direction 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.
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 retrievals to this cook book only.

CompliancemandatoryThis method is must be implemented.
MethodgetDirection
Description

Gets the Direction specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Direction may have a different Id than requested, such as the case where a duplicate Id was assigned to a Direction and retained for compatibility.

Parametersosid.id.IddirectionIdthe Id of the Direction to retrieve
Returnosid.recipe.Directionthe returned Direction
ErrorsNOT_FOUNDno Direction found with the given Id
NULL_ARGUMENT directionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByIds
Description

Gets a DirectionList corresponding to the given IdList. In plenary mode, the returned list contains all of the directions specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Directions may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListdirectionIdsthe list of Ids to retrieve
Returnosid.recipe.DirectionListthe returned Direction list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT directionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByGenusType
Description

Gets a DirectionList corresponding to the given direction genus Type which does not include directions of types derived from the specified Type. In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.

Parametersosid.type.TypedirectionGenusTypea direction genus type
Returnosid.recipe.DirectionListthe returned Direction list
ErrorsNULL_ARGUMENT directionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByParentGenusType
Description

Gets a DirectionList corresponding to the given direction genus Type and include any additional directions with genus types derived from the specified Type. In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.

Parametersosid.type.TypedirectionGenusTypea direction genus type
Returnosid.recipe.DirectionListthe returned Direction list
ErrorsNULL_ARGUMENT directionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsByRecordType
Description

Gets a DirectionList containing the given direction record Type. In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.

Parametersosid.type.TypedirectionRecordTypea direction record type
Returnosid.recipe.DirectionListthe returned Direction list
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectionsForRecipe
Description

Gets a DirectionList for the given recipe Id. In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.

Parametersosid.id.IdrecipeIda recipe Id
Returnosid.recipe.DirectionListthe returned Direction list
ErrorsNULL_ARGUMENT recipeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirections
Description

Gets all directions. In plenary mode, the returned list contains all of the directions, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Directions may be omitted from the list and may present the elements in any order including returning a unique set.

Returnosid.recipe.DirectionListthe returned Direction list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.