OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.PathSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.path.PathSearchSession
Description

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

MethodgetPaths
Description

Gets the path list resulting from a search.

Returnosid.mapping.path.PathList the path list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetPathQueryInspector
Description

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

Returnosid.mapping.path.PathQueryInspector the path query inspector
Compliancemandatory This method must be implemented.
MethodgetPathSearchResultsRecord
Description

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

Parametersosid.type.TypepathSearchRecordType a path search record type
Returnosid.mapping.path.records.PathSearchResultsRecord the path search results record
ErrorsNULL_ARGUMENT pathSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(pathSearchRecordType) is false
Compliancemandatory This method must be implemented.