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

Interface	osid.mapping.path.ObstacleSearchSession
Implements	`osid.mapping.path.ObstacleQuerySession`
Description	This session provides methods for searching among `Obstacle` objects. The search query is constructed using the `ObstacleQuery.` `getObstaclesByQuery()` is the basic search method and returns a list of `Obstacles.` A more advanced search may be performed with `getObstaclesBySearch().` It accepts an `ObstacleSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getObstaclesBySearch()` returns an `ObstacleSearchResults` that can be used to access the resulting `ObstacleList` or be used to perform a search within the result set through `ObstacleSearch.` This session defines views that offer differing behaviors for searching. federated map view: searches include obstacle in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to obstacle in this map Obstacles may have a query record indicated by their respective record types. The query record is accessed via the `ObstacleQuery.`
Method	getObstacleSearch
Description	Gets an obstacle search.
Return	`osid.mapping.path.ObstacleSearch`		the obstacle search
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleSearchOrder
Description	Gets an obstacle search order. The `ObstacleSearchOrder` is supplied to an `ObstacleSearch` to specify the ordering of results.
Return	`osid.mapping.path.ObstacleSearchOrder`		the obstacle search order
Compliance	`mandatory`		This method must be implemented.
Method	getObstaclesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.ObstacleQuery`	`obstacleQuery`	the obstacle query
Parameters	`osid.mapping.path.ObstacleSearch`	`obstacleSearch`	the obstacle search
Return	`osid.mapping.path.ObstacleSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`obstacleQuery` or `obstacleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`obstacleQuery` or `obstacleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleQueryFromInspector
Description	Gets an obstacle query from an inspector. The inspector is available from an `ObstacleSearchResults.`
Parameters	`osid.mapping.path.ObstacleQueryInspector`	`obstacleQueryInspector`	an obstacle query inspector
Return	`osid.mapping.path.ObstacleQuery`		the obstacle query
Errors	NULL_ARGUMENT		`obstacleQueryInspector` is `null`
Errors	UNSUPPORTED		`obstacleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.