OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.DirectionSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDirections
Description

Gets the direction list resulting from a search.

Returnosid.recipe.DirectionListthe direction list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDirectionQueryInspector
Description

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

Returnosid.recipe.DirectionQueryInspectorthe direction query inspector
CompliancemandatoryThis 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.TypedirectionSearchRecordTypea direction search record type
Returnosid.recipe.records.DirectionSearchResultsRecordthe direction search results 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.