| Interface | osid.installation.PackageSearchSession | ||
|---|---|---|---|
| Implements | osid.installation.PackageQuerySession | ||
| Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Packages may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| 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 | ||
| 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 |
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 | ||
| Parameters | osid.installation.PackageQueryInspector | packageQueryInspector | a package query inspector |
| Return | osid.installation.PackageQuery | the package query | |
| Errors | NULL_ARGUMENT | packageQueryInspector is null | |
| UNSUPPORTED | packageQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |