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

The search interface for governing obstacle enabler searches.

MethodsearchAmongObstacleEnablers
Description

Execute this search among the given list of obstacle enablers.

Parametersosid.id.IdListmapIdslist of obstacle enablers
ErrorsNULL_ARGUMENT mapIds is null
CompliancemandatoryThis method must be implemented.
MethodorderObstacleEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.rules.ObstacleEnablerSearchOrderobstacleEnablerSearchOrderobstacle enabler search order
ErrorsNULL_ARGUMENT obstacleEnablerSearchOrder is null
UNSUPPORTED obstacleEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerSearchRecord
Description

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

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