OSID - osid.mapping.path.ObstacleSearch Service Interface Definition

Interface	osid.mapping.path.ObstacleSearch
Implements	`osid.OsidSearch`
Description	The search interface for governing obstacle searches.
Method	searchAmongObstacles
Description	Execute this search among the given list of obstacle.
Parameters	`osid.id.IdList`	`obstacleIds`	list of obstacle
Errors	NULL_ARGUMENT		`obstacleIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderObstacleResults
Description	Specify an ordering to the search results.
Parameters	`osid.mapping.path.ObstacleSearchOrder`	`obstacleSearchOrder`	obstacle search order
Errors	NULL_ARGUMENT		`obstacleSearchOrder` is `null`
Errors	UNSUPPORTED		`obstacleSearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleSearchRecord
Description	Gets the record corresponding to the given obstacle search record `Type.` This method is used to retrieve an object implementing the requested record.
Parameters	`osid.type.Type`	`obstacleSearchRecordType`	an obstacle search record type
Return	`osid.mapping.path.records.ObstacleSearchRecord`		the obstacle search record
Errors	NULL_ARGUMENT		`obstacleSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(obstacleSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.