OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookSearch
Implementsosid.OsidSearch
Description

The search interface for governing book searches.

MethodsearchAmongBooks
Description

Execute this search among the given list of books.

Parametersosid.id.IdListbookIdslist of books
ErrorsNULL_ARGUMENT bookIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBookResults
Description

Specify an ordering to the search results.

Parametersosid.commenting.BookSearchOrderbookSearchOrderbook search order
ErrorsNULL_ARGUMENT bookSearchOrder is null
UNSUPPORTED bookSearchOrder is not of this service
CompliancemandatoryThis 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.TypebookSearchRecordTypea book search record type
Returnosid.commenting.records.BookSearchRecordthe book search record
ErrorsNULL_ARGUMENT bookSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bookSearchRecordType) is false
CompliancemandatoryThis method must be implemented.