Interface | osid.installation.PackageSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPackages | ||
Description |
Gets the package list resulting from the search. | ||
Return | osid.installation.PackageList | the package list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPackageQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.installation.PackageQueryInspector | the package query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPackageSearchResultsRecord | ||
Description |
Gets the package search results record corresponding to
the given package search record | ||
Parameters | osid.type.Type | packageSearchRecordType | a package search record type |
Return | osid.installation.records.PackageSearchResultsRecord | the package search results record | |
Errors | NULL_ARGUMENT | packageSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(packageSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |