OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
commenting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.commenting.BookSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBooks | ||
| Description |
Gets the book list resulting from a search. | ||
| Return | osid.commenting.BookList | the book list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBookQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.commenting.BookQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBookSearchResultsRecord | ||
| Description |
Gets the book search results record corresponding to the given book search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | bookSearchRecordType | a book search record type |
| Return | osid.commenting.records.BookSearchResultsRecord | the book search results record | |
| Errors | NULL_ARGUMENT | BookSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(bookSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |