| Interface | osid.installation.InstallationPackageSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.installation.InstallationPackageSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getInstallationPackages | ||
| Description |
Gets the package list resulting from the search. | ||
| Return | osid.installation.InstallationPackageList | the package list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationPackageQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.installation.InstallationPackageQueryInspector | the package query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationPackageSearchResultsRecord | ||
| Description |
Gets the package search results record corresponding
to the given package search record | ||
| Parameters | osid.type.Type | installationPackageSearchRecordType | a package search record type |
| Return | osid.installation.records.InstallationPackageSearchResultsRecord | the package search results record | |
| Errors | NULL_ARGUMENT | installationPackageSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(packageSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |