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

Interface	osid.mapping.path.rules.SignalEnablerSearchSession
Implements	`osid.mapping.path.rules.SignalEnablerQuerySession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods for searching among `SignalEnabler` objects. The search query is constructed using the `SignalEnableryQuery` . `getSignalEnablersByQuery()` is the basic search method and returns a list of `SignalEnablers` . A more advanced search may be performed with `getSignalEnablersBySearch()` .It accepts a `SignalEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. `getSignalEnablersBySearch()` returns a `SignalEnablerSearchResults` that can be used to access the resulting `SignalEnablerList` or be used to perform a search within the result set through `SignalEnablerSearch` . This session defines views that offer differing behaviors for searching. federated map view: searches include signal enabler in map of which this map matchmaker is an ancestor in the map hierarchy isolated map view: searches are restricted to signal enabler in this office `SignalEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `SignalEnablerQuery` .
Method	getSignalEnablerSearch
Description	Gets a signal enabler search.
Return	`osid.mapping.path.rules.SignalEnablerSearch`		the signal enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablerSearchOrder
Description	Gets a signal enabler search order. The `SignalEnablerSearchOrder` is supplied to a `SignalEnablerSearch` to specify the ordering of results.
Return	`osid.mapping.path.rules.SignalEnablerSearchOrder`		the signal enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.rules.SignalEnablerQuery`	`signalEnablerQuery`	the signal enabler query
Parameters	`osid.mapping.path.rules.SignalEnablerSearch`	`signalEnablerSearch`	the signal enabler search
Return	`osid.mapping.path.rules.SignalEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`signalEnablerQuery` or `signalEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`signalEnablerQuery` or `signalEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablerQueryFromInspector
Description	Gets a signal enabler query from an inspector. The inspector is available from a `SignalEnablerSearchResults` .
Parameters	`osid.mapping.path.rules.SignalEnablerQueryInspector`	`signalEnablerQueryInspector`	a signal enabler query inspector
Return	`osid.mapping.path.rules.SignalEnablerQuery`		the signal enabler query
Errors	NULL_ARGUMENT		`signalEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`signalEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.