OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.DirectionSearch
Implementsosid.OsidSearch
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_ARGUMENT directionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDirectionResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.DirectionSearchOrderdirectionSearchOrderdirection search order
ErrorsNULL_ARGUMENT directionSearchOrder is null
UNSUPPORTED directionSearchOrder 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_ARGUMENT directionSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(directionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.