| Interface | osid.repository.RepositorySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRepositories | ||
| Description |
Gets the repository list resulting from the search. | ||
| Return | osid.repository.RepositoryList | the repository list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepositoryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.repository.RepositoryQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepositorySearchResultsRecord | ||
| Description |
Gets the repository search results record corresponding
to the given repository search record | ||
| Parameters | osid.type.Type | repositorySearchRecordType | a repository search record type |
| Return | osid.repository.records.RepositorySearchResultsRecord | the repository search results record | |
| Errors | NULL_ARGUMENT | repositorySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(repositorySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |