OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.ObstacleSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetObstacles
Description

Gets the obstacle list resulting from a search.

Returnosid.mapping.path.ObstacleListthe obstacle list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetObstacleQueryInspector
Description

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

Returnosid.mapping.path.ObstacleQueryInspectorthe obstacle query inspector
CompliancemandatoryThis method must be implemented.
MethodgetObstacleSearchResultsRecord
Description

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

Parametersosid.type.TypeobstacleSearchRecordTypean obstacle search record type
Returnosid.mapping.path.records.ObstacleSearchResultsRecordthe obstacle search results record
ErrorsNULL_ARGUMENT obstacleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(obstacleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.