OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.BookSearch
Implementsosid.OsidSearch
Used Byosid.commenting.BookSearchSession
Description

The search interface for governing book searches.

MethodsearchAmongBooks
Description

Execute this search among the given list of books.

Parametersosid.id.IdListbookIds list of books
ErrorsNULL_ARGUMENT bookIds is null
Compliancemandatory This method must be implemented.
MethodorderBookResults
Description

Specify an ordering to the search results.

Parametersosid.commenting.BookSearchOrderbookSearchOrder book search order
ErrorsNULL_ARGUMENT bookSearchOrder is null
UNSUPPORTED bookSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBookSearchRecord
Description

Gets the book search 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.BookSearchRecord the book search record
ErrorsNULL_ARGUMENT bookSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(bookSearchRecordType) is false
Compliancemandatory This method must be implemented.