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

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

MethodgetObstacleEnablers
Description

Gets the ObstacleEnablerList resulting from a search.

Returnosid.mapping.path.rules.ObstacleEnablerListthe obstacle enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQueryInspector
Description

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

Returnosid.mapping.path.rules.ObstacleEnablerQueryInspectorthe obstacle enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerSearchResultsRecord
Description

Gets the obstacle enabler search results record corresponding to the given obstacle enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypeobstacleEnablerSearchRecordTypean obstacle enabler search record type
Returnosid.mapping.path.rules.records.ObstacleEnablerSearchResultsRecordthe obstacle enabler search results record
ErrorsNULL_ARGUMENT obstacleEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(obstacleEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.