OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.BookSearchResults
Implementsosid.OsidSearchResults
Used Byosid.commenting.BookSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetBooks
Description

Gets the book list resulting from a search.

Returnosid.commenting.BookList the book list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetBookQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.commenting.BookQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetBookSearchResultsRecord
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.

Parametersosid.type.TypebookSearchRecordType a book search record type
Returnosid.commenting.records.BookSearchResultsRecord the book search results record
ErrorsNULL_ARGUMENT BookSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(bookSearchRecordType) is false
Compliancemandatory This method must be implemented.