OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Interfaceosid.recipe.DirectionSearch
Implementsosid.OsidSearch
Used Byosid.recipe.DirectionSearchSession
Description

The search interface for governing direction searches.

MethodsearchAmongDirections
Description

Execute this search among the given list of directions.

Parametersosid.id.IdListdirectionIdslist of directions
ErrorsNULL_ARGUMENTdirectionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDirectionResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.DirectionSearchOrderdirectionSearchOrderdirection search order
ErrorsNULL_ARGUMENTdirectionSearchOrder is null
UNSUPPORTEDdirectionSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDirectionSearchRecord
Description

Gets the direction search record corresponding to the given direction search record Type . This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypedirectionSearchRecordTypea direction search record type
Returnosid.recipe.records.DirectionSearchRecordthe direction search record
ErrorsNULL_ARGUMENTdirectionSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTEDhasRecordType(directionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.