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

Interface	osid.mapping.path.SignalSearchSession
Implements	`osid.mapping.path.SignalQuerySession`
Description	This session provides methods for searching among `Signal` objects. The search query is constructed using the `SignalQuery.` `getSignalsByQuery()` is the basic search method and returns a list of `Signals.` A more advanced search may be performed with `getSignalsBySearch().` It accepts a `SignalSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSignalsBySearch()` returns a `SignalSearchResults` that can be used to access the resulting `SignalList` or be used to perform a search within the result set through `SignalSearch.` This session defines views that offer differing behaviors for searching. federated map view: searches include signals in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to signals in this map Signals may have a query record indicated by their respective record types. The query record is accessed via the `SignalQuery.`
Method	getSignalSearch
Description	Gets a signal search.
Return	`osid.mapping.path.SignalSearch`		the signal search
Compliance	`mandatory`		This method must be implemented.
Method	getSignalSearchOrder
Description	Gets a signal search order. The `SignalSearchOrder` is supplied to a `SignalSearch` to specify the ordering of results.
Return	`osid.mapping.path.SignalSearchOrder`		the signal search order
Compliance	`mandatory`		This method must be implemented.
Method	getSignalsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.SignalQuery`	`signalQuery`	the signal query
Parameters	`osid.mapping.path.SignalSearch`	`signalSearch`	the signal search
Return	`osid.mapping.path.SignalSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`signalQuery` or `signalSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`signalQuery` or `signalSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSignalQueryFromInspector
Description	Gets a signal query from an inspector. The inspector is available from a `SignalSearchResults.`
Parameters	`osid.mapping.path.SignalQueryInspector`	`signalQueryInspector`	a signal query inspector
Return	`osid.mapping.path.SignalQuery`		the signal query
Errors	NULL_ARGUMENT		`signalQueryInspector` is `null`
Errors	UNSUPPORTED		`signalQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.