OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.ObstacleSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.path.ObstacleSearchSession
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.ObstacleList the obstacle list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetObstacleQueryInspector
Description

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

Returnosid.mapping.path.ObstacleQueryInspector the obstacle query inspector
Compliancemandatory This 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.TypeobstacleSearchRecordType an obstacle search record type
Returnosid.mapping.path.records.ObstacleSearchResultsRecord the obstacle search results record
ErrorsNULL_ARGUMENT obstacleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(obstacleSearchRecordType) is false
Compliancemandatory This method must be implemented.