OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.ObstacleSearch
Implementsosid.OsidSearch
Used Byosid.mapping.path.ObstacleSearchSession
Description

The search interface for governing obstacle searches.

MethodsearchAmongObstacles
Description

Execute this search among the given list of obstacle.

Parametersosid.id.IdListobstacleIds list of obstacle
ErrorsNULL_ARGUMENT obstacleIds is null
Compliancemandatory This method must be implemented.
MethodorderObstacleResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.ObstacleSearchOrderobstacleSearchOrder obstacle search order
ErrorsNULL_ARGUMENT obstacleSearchOrder is null
UNSUPPORTED obstacleSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetObstacleSearchRecord
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.ObstacleSearchRecord the obstacle search record
ErrorsNULL_ARGUMENT obstacleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(obstacleSearchRecordType) is false
Compliancemandatory This method must be implemented.