Interface BookSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BookSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BookQueryInspector	getBookQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
BookList	getBooks()	Gets the book list resulting from a search.
BookSearchResultsRecord	getBookSearchResultsRecord(Type bookSearchRecordType)	Gets the book search results record corresponding to the given book search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBooks

BookList getBooks()

Gets the book list resulting from a search.

Returns:

the book list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBookQueryInspector

BookQueryInspector getBookQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBookSearchResultsRecord

BookSearchResultsRecord getBookSearchResultsRecord(Type bookSearchRecordType)
                                            throws OperationFailedException

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.

Parameters:

bookSearchRecordType - a book search record type

Returns:

the book search results record

Throws:

NullArgumentException - BookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.