OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.PathSearchResults
Implementsosid.OsidSearchResults
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.PathListthe path list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPathQueryInspector
Description

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

Returnosid.mapping.path.PathQueryInspectorthe path query inspector
CompliancemandatoryThis 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.TypepathSearchRecordTypea path search record type
Returnosid.mapping.path.records.PathSearchResultsRecordthe path search results record
ErrorsNULL_ARGUMENT pathSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathSearchRecordType) is false
CompliancemandatoryThis method must be implemented.