| Interface | osid.commenting.BookSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing book searches.  | ||
| Method | searchAmongBooks | ||
| Description | 
                     Execute this search among the given list of books.  | ||
| Parameters | osid.id.IdList | bookIds | list of books | 
| Errors | NULL_ARGUMENT |  bookIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBookResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.commenting.BookSearchOrder | bookSearchOrder | book search order | 
| Errors | NULL_ARGUMENT |  bookSearchOrder  is  null   |                 |
| UNSUPPORTED |  bookSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBookSearchRecord | ||
| Description | 
                     Gets the book search record corresponding to the given 
                    book search record   | ||
| Parameters | osid.type.Type | bookSearchRecordType | a book search record type | 
| Return | osid.commenting.records.BookSearchRecord | the book search 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. | |