OSID Logo
OSID Specifications
recipe package
Version 3.1.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.IdListdirectionIds list of directions
ErrorsNULL_ARGUMENT directionIds is null
Compliancemandatory This method must be implemented.
MethodorderDirectionResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.DirectionSearchOrderdirectionSearchOrder direction search order
ErrorsNULL_ARGUMENT directionSearchOrder is null
UNSUPPORTED directionSearchOrder is not of this service
Compliancemandatory This 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.TypedirectionSearchRecordType a direction search record type
Returnosid.recipe.records.DirectionSearchRecord the direction search record
ErrorsNULL_ARGUMENT directionSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(directionSearchRecordType) is false
Compliancemandatory This method must be implemented.