OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.DirectionSearchResults
Implementsosid.OsidSearchResults
Used Byosid.recipe.DirectionSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetDirections
Description

Gets the direction list resulting from a search.

Returnosid.recipe.DirectionList the direction list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDirectionQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.recipe.DirectionQueryInspector the direction query inspector
Compliancemandatory This method must be implemented.
MethodgetDirectionSearchResultsRecord
Description

Gets the direction search results 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.DirectionSearchResultsRecord the direction search results 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.