OSID - osid.installation.InstallationSearchSession Service Interface Definition

Interface	osid.installation.InstallationSearchSession
Implements	`osid.installation.InstallationQuerySession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session provides methods for searching `Installations` . The search query is constructed using the `InstallationQuery` . The installation record `Type` also specifies the record for the installation query. `getInstallationsByQuery()` is the basic search method and returns a list of `Installations` . A more advanced search may be performed with `getInstallationsBySearch()` .It accepts an `InstallationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getInstallationsBySearch()` returns an `InstallationSearchResults` that can be used to access the resulting `InstallationList` or be used to perform a search within the result set through `InstallationSearch` . Installations may have a query record indicated by their respective record types. The query record is accessed via the `InstallationQuery` .
Method	getInstallationSearch
Description	Gets an installation search.
Return	`osid.installation.InstallationSearch`		the installation search
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationSearchOrder
Description	Gets an installation search order. The `InstallationSearchOrder` is supplied to an `InstallationSearch` to specify the ordering of results.
Return	`osid.installation.InstallationSearchOrder`		the installation search order
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.installation.InstallationQuery`	`installationQuery`	the installation query
Parameters	`osid.installation.InstallationSearch`	`installationSearch`	the installation search
Return	`osid.installation.InstallationSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`installationQuery` or `installationSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`installationSearch` or `installationQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsQueryFromInspector
Description	Gets an installation query from an inspector. The inspector is available from a `InstallationSearchResults` .
Parameters	`osid.installation.InstallationQueryInspector`	`installatonQueryInspector`	an installation query inspector
Return	`osid.installation.InstallationQuery`		the installaton query
Errors	NULL_ARGUMENT		`installationQueryInspector` is `null`
Errors	UNSUPPORTED		`installationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.