OSID - osid.mapping.path.rules.ObstacleEnablerSearchSession Service Interface Definition

Interface	osid.mapping.path.rules.ObstacleEnablerSearchSession
Implements	`osid.mapping.path.rules.ObstacleEnablerQuerySession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods for searching among `ObstacleEnabler` objects. The search query is constructed using the `ObstacleEnableryQuery` . `getObstacleEnablersByQuery()` is the basic search method and returns a list of `ObstacleEnablers` . A more advanced search may be performed with `getObstacleEnablersBySearch()` . It accepts an `ObstacleEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. `getObstacleEnablersBySearch()` returns an `ObstacleEnablerSearchResults` that can be used to access the resulting `ObstacleEnablerList` or be used to perform a search within the result set through `ObstacleEnablerSearch` . This session defines views that offer differing behaviors for searching. federated map view: searches include obstacle enabler in map of which this map matchmaker is an ancestor in the map hierarchy isolated map view: searches are restricted to obstacle enabler in this office `ObstacleEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ObstacleEnablerQuery` .
Method	getObstacleEnablerSearch
Description	Gets an obstacle enabler search.
Return	`osid.mapping.path.rules.ObstacleEnablerSearch`		the obstacle enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablerSearchOrder
Description	Gets an obstacle enabler search order. The `ObstacleEnablerSearchOrder` is supplied to an `ObstacleEnablerSearch` to specify the ordering of results.
Return	`osid.mapping.path.rules.ObstacleEnablerSearchOrder`		the obstacle enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.rules.ObstacleEnablerQuery`	`obstacleEnablerQuery`	the obstacle enabler query
Parameters	`osid.mapping.path.rules.ObstacleEnablerSearch`	`obstacleEnablerSearch`	the obstacle enabler search
Return	`osid.mapping.path.rules.ObstacleEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`obstacleEnablerQuery` or `obstacleEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`obstacleEnablerQuery` or `obstacleEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablerQueryFromInspector
Description	Gets an obstacle enabler query from an inspector. The inspector is available from an `ObstacleEnablerSearchResults` .
Parameters	`osid.mapping.path.rules.ObstacleEnablerQueryInspector`	`obstacleEnablerQueryInspector`	an obstacle enabler query inspector
Return	`osid.mapping.path.rules.ObstacleEnablerQuery`		the obstacle enabler query
Errors	NULL_ARGUMENT		`obstacleEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`obstacleEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.