| Interface | osid.installation.InstallationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getInstallations | ||
| Description |
Gets the installation list resulting from the search. | ||
| Return | osid.installation.InstallationList | the installation list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.installation.InstallationQueryInspector | the installation query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationSearchResultsRecord | ||
| Description |
Gets the installation search results record
corresponding to the given installation search record
| ||
| Parameters | osid.type.Type | installationSearchRecordType | an installation search record type |
| Return | osid.installation.records.InstallationSearchResultsRecord | the installation search results record | |
| Errors | NULL_ARGUMENT | installationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(installationSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |