OSID - osid.control.SystemSearchSession Service Interface Definition

Interface	osid.control.SystemSearchSession
Implements	`osid.control.SystemQuerySession`
Description	This session provides methods for searching among `System` objects. The search query is constructed using the `SystemQuery.` `getSystemsByQuery()` is the basic search method and returns a list of `Systems.` A more advanced search may be performed with `getSystemsBySearch().` It accepts a `SystemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSystemsBySearch()` returns a `SystemSearchResults` that can be used to access the resulting `SystemList` or be used to perform a search within the result set through `SystemSearch.` Systems may have a query record indicated by their respective record types. The query record is accessed via the `SystemQuery.`
Method	getSystemSearch
Description	Gets a system search.
Return	`osid.control.SystemSearch`		the system search
Compliance	`mandatory`		This method must be implemented.
Method	getSystemSearchOrder
Description	Gets a system search order. The `SystemSearchOrder` is supplied to a `SystemSearch` to specify the ordering of results.
Return	`osid.control.SystemSearchOrder`		the system search order
Compliance	`mandatory`		This method must be implemented.
Method	getSystemsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.SystemQuery`	`systemQuery`	the system query
Parameters	`osid.control.SystemSearch`	`systemSearch`	the system search
Return	`osid.control.SystemSearchResults`		the system search results
Errors	NULL_ARGUMENT		`systemQuery` or `systemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`systemQuery` or `systemSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSystemQueryFromInspector
Description	Gets a system query from an inspector. The inspector is available from a `SystemSearchResults.`
Parameters	`osid.control.SystemQueryInspector`	`systemQueryInspector`	a system query inspector
Return	`osid.control.SystemQuery`		the system query
Errors	NULL_ARGUMENT		`systemQueryInspector` is `null`
Errors	UNSUPPORTED		`systemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.