Interface BookSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BookSearch
extends OsidSearch

The search interface for governing book searches.

Method Summary

Modifier and Type	Method	Description
BookSearchRecord	getBookSearchRecord(Type bookSearchRecordType)	Gets the book search record corresponding to the given book search record Type .
void	orderBookResults(BookSearchOrder bookSearchOrder)	Specify an ordering to the search results.
void	searchAmongBooks(IdList bookIds)	Execute this search among the given list of books.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBooks

void searchAmongBooks(IdList bookIds)

Execute this search among the given list of books.

Parameters:

bookIds - list of books

Throws:

NullArgumentException - bookIds is null

Compliance:

mandatory - This method must be implemented.

orderBookResults

void orderBookResults(BookSearchOrder bookSearchOrder)

Specify an ordering to the search results.

Parameters:

bookSearchOrder - book search order

Throws:

NullArgumentException - bookSearchOrder is null

UnsupportedException - bookSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBookSearchRecord

BookSearchRecord getBookSearchRecord(Type bookSearchRecordType)
                              throws OperationFailedException

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.

Parameters:

bookSearchRecordType - a book search record type

Returns:

the book search record

Throws:

NullArgumentException - bookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.