OSID - osid.installation.PackageSearchSession Service Interface Definition

Interface	osid.installation.PackageSearchSession
Implements	`osid.installation.PackageQuerySession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session provides methods for searching `Packages` . The search query is constructed using the `PackageQuery` . The package record `Type` also specifies the record for the package query. `getPackagesByQuery()` is the basic search method and returns a list of `Packages` . A more advanced search may be performed with `getPackagesBySearch()` .It accepts a `PackageSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPackagesBySearch()` returns a `PackageSearchResults` that can be used to access the resulting `PackageList` or be used to perform a search within the result set through `PackageSearch` . 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 Packages may have a query record indicated by their respective record types. The query record is accessed via the `PackageQuery` .
Method	getPackageSearch
Description	Gets a package search.
Return	`osid.installation.PackageSearch`		the package search
Compliance	`mandatory`		This method must be implemented.
Method	getPackageSearchOrder
Description	Gets a package search order. The `PackageSearchOrder` is supplied to a `PackageSearch` to specify the ordering of results.
Return	`osid.installation.PackageSearchOrder`		the package search order
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.installation.PackageQuery`	`packageQuery`	the package query
Parameters	`osid.installation.PackageSearch`	`packageSearch`	the package search
Return	`osid.installation.PackageSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`packageQuery` or `packageSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`packageSearch` or `packageQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPackageQueryFromInspector
Description	Gets a package query from an inspector. The inspector is available from a `PackageeSearchResults` .
Parameters	`osid.installation.PackageQueryInspector`	`packageQueryInspector`	a package query inspector
Return	`osid.installation.PackageQuery`		the package query
Errors	NULL_ARGUMENT		`packageQueryInspector` is `null`
Errors	UNSUPPORTED		`packageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.