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

Interface	osid.mapping.path.IntersectionSearchSession
Implements	`osid.mapping.path.IntersectionQuerySession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods for searching among `Intersection` objects. The search query is constructed using the `IntersectionQuery`. `getIntersectionsByQuery()` is the basic search method and returns a list of `Intersections`. A more advanced search may be performed with `getIntersectionsBySearch()`.It accepts an `IntersectionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIntersectionsBySearch()` returns an `IntersectionSearchResults` that can be used to access the resulting `IntersectionList` or be used to perform a search within the result set through `IntersectionSearch`. This session defines views that offer differing behaviors for searching. federated map view: searches include intersections in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to intersections in this map Intersections may have a query record indicated by their respective record types. The query record is accessed via the `IntersectionQuery`.
Method	getIntersectionSearch
Description	Gets an intersection search.
Return	`osid.mapping.path.IntersectionSearch`		the intersection search
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionSearchOrder
Description	Gets an intersection search order. The `IntersectionSearchOrder` is supplied to an `IntersectionSearch` to specify the ordering of results.
Return	`osid.mapping.path.IntersectionSearchOrder`		the intersection search order
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.IntersectionQuery`	`intersectionQuery`	the intersection query
Parameters	`osid.mapping.path.IntersectionSearch`	`intersectionSearch`	the intersection search
Return	`osid.mapping.path.IntersectionSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`intersectionQuery` or `intersectionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`intersectionQuery` or `intersectionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionQueryFromInspector
Description	Gets an intersection query from an inspector. The inspector is available from an `IntersectionSearchResults`.
Parameters	`osid.mapping.path.IntersectionQueryInspector`	`intersectionQueryInspector`	an intersection query inspector
Return	`osid.mapping.path.IntersectionQuery`		the intersection query
Errors	NULL_ARGUMENT		`intersectionQueryInspector` is `null`
Errors	UNSUPPORTED		`intersectionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.