OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.ObstacleEnablerSearch
Implementsosid.OsidSearch
Used Byosid.mapping.path.rules.ObstacleEnablerSearchSession
Description

The search interface for governing obstacle enabler searches.

MethodsearchAmongObstacleEnablers
Description

Execute this search among the given list of obstacle enablers.

Parametersosid.id.IdListmapIds list of obstacle enablers
ErrorsNULL_ARGUMENT mapIds is null
Compliancemandatory This method must be implemented.
MethodorderObstacleEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.rules.ObstacleEnablerSearchOrderobstacleEnablerSearchOrder obstacle enabler search order
ErrorsNULL_ARGUMENT obstacleEnablerSearchOrder is null
UNSUPPORTED obstacleEnablerSearchOrder is not of this service
Compliancemandatory This 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.TypeobstacleEnablerSearchRecordType an obstacle enabler search record type
Returnosid.mapping.path.rules.records.ObstacleEnablerSearchRecord the obstacle enabler search record
ErrorsNULL_ARGUMENT obstacleEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(obstacleEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.