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

Interface	osid.mapping.path.PathSearchSession
Implements	`osid.mapping.path.PathQuerySession`
Description	This session provides methods for searching among `Path` objects. The search query is constructed using the `PathQuery.` `getPathsByQuery()` is the basic search method and returns a list of `Paths.` A more advanced search may be performed with `getPathsBySearch().` It accepts a `PathSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPathsBySearch()` returns a `PathSearchResults` that can be used to access the resulting `PathList` or be used to perform a search within the result set through `PathSearch.` This session defines views that offer differing behaviors for searching. federated map view: searches include paths in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to paths in this map Paths may have a query record indicated by their respective record types. The query record is accessed via the `PathQuery.`
Method	getPathSearch
Description	Gets a path search.
Return	`osid.mapping.path.PathSearch`		the path search
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchOrder
Description	Gets a path search order. The `PathSearchOrder` is supplied to a `PathSearch` to specify the ordering of results.
Return	`osid.mapping.path.PathSearchOrder`		the path search order
Compliance	`mandatory`		This method must be implemented.
Method	getPathsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.PathQuery`	`pathQuery`	the path query
Parameters	`osid.mapping.path.PathSearch`	`pathSearch`	the path search
Return	`osid.mapping.path.PathSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`pathQuery` or `pathSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pathQuery` or `pathSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPathQueryFromInspector
Description	Gets a path query from an inspector. The inspector is available from a `PathSearchResults.`
Parameters	`osid.mapping.path.PathQueryInspector`	`pathQueryInspector`	a path query inspector
Return	`osid.mapping.path.PathQuery`		the path query
Errors	NULL_ARGUMENT		`pathQueryInspector` is `null`
Errors	UNSUPPORTED		`pathQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.