OSID - osid.installation.InstallationPackageSearchSession Service Interface Definition

Interface	osid.installation.InstallationPackageSearchSession
Implements	`osid.installation.InstallationPackageQuerySession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session provides methods for searching `InstallationPackages`. The search query is constructed using the `InstallationPackageQuery`. The package record `Type` also specifies the record for the package query. `getInstallationPackagesByQuery()` is the basic search method and returns a list of `InstallationPackages`. A more advanced search may be performed with `getInstallationPackagesBySearch()`.It accepts a `InstallationPackageSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getInstallationPackagesBySearch()` returns a `InstallationPackageSearchResults` that can be used to access the resulting `InstallationPackageList` or be used to perform a search within the result set through `InstallationPackageSearch`. This session defines views that offer differing behaviors for searching. federated depot view: searches include packages in depots of which this depot is a ancestor in the depot hierarchy isolated depot view: searches are restricted to packages in this depot normalized version view: multiple versions of the same package are suppressed denormalized version vew: all versions of an installation are returned normalized dependency view: supporting installations upon which other installations depend are suppressed denormalized dependency view: all dependencies are returned InstallationPackages may have a query record indicated by their respective record types. The query record is accessed via the `InstallationPackageQuery`.
Method	getInstallationPackageSearch
Description	Gets a package search.
Return	`osid.installation.InstallationPackageSearch`		the package search
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageSearchOrder
Description	Gets a package search order. The `InstallationPackageSearchOrder` is supplied to a `InstallationPackageSearch` to specify the ordering of results.
Return	`osid.installation.InstallationPackageSearchOrder`		the package search order
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackagesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.installation.InstallationPackageQuery`	`installationPackageQuery`	the package query
Parameters	`osid.installation.InstallationPackageSearch`	`installationPackageSearch`	the package search
Return	`osid.installation.InstallationPackageSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`installationPackageQuery` or `installationPackageSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`installationPackageSearch` or `installationPackageQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageQueryFromInspector
Description	Gets a package query from an inspector. The inspector is available from a `InstallationPackageeSearchResults`.
Parameters	`osid.installation.InstallationPackageQueryInspector`	`installationPackageQueryInspector`	a package query inspector
Return	`osid.installation.InstallationPackageQuery`		the package query
Errors	NULL_ARGUMENT		`installationPackageQueryInspector` is `null`
Errors	UNSUPPORTED		`installationPackageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.