Interface BookSearchSession

All Superinterfaces:

AutoCloseable, BookQuerySession, Closeable, OsidSession, OsidSession

public interface BookSearchSession
extends BookQuerySession

This session provides methods for searching Books. The search query is constructed using the BookQuery. The book record Type also specifies the record for the book query.

getBooksByQuery() is the basic search method and returns a list of Book elements. A more advanced search may be performed with getBooksBySearch(). It accepts a BookSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBooksBySearch() returns a BookSearchResults that can be used to access the resulting BookList or be used to perform a search within the result set through BookSearch.

Books may have a query record indicated by their respective record types. The query record is accessed via the BookQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
BookQuery	getBookQueryFromInspector(BookQueryInspector bookQueryInspector)	Gets an entry query from an inspector.
BookSearchResults	getBooksBySearch(BookQuery bookQuery, BookSearch bookSearch)	Gets the search results matching the given search.
BookSearch	getBookSearch()	Gets a book search.
BookSearchOrder	getBookSearchOrder()	Gets a book search order.

Methods inherited from interface BookQuerySession

canSearchBooks, getBookQuery, getBooksByQuery

Modifier and Type	Method	Description
boolean	canSearchBooks()	Tests if this user can perform Book searches.
BookQuery	getBookQuery()	Gets a book query.
BookList	getBooksByQuery(BookQuery bookQuery)	Gets a list of Books matching the given search.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBookSearch

BookSearch getBookSearch()

Gets a book search.

Returns:

the book search

Compliance:

mandatory - This method must be implemented.

getBookSearchOrder

BookSearchOrder getBookSearchOrder()

Gets a book search order. The BookSearchOrder is supplied to a BookSearch to specify the ordering of results.

Returns:

the book search order

Compliance:

mandatory - This method must be implemented.

getBooksBySearch

BookSearchResults getBooksBySearch(BookQuery bookQuery,
 BookSearch bookSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

bookQuery - the book query

bookSearch - the book search

Returns:

the search results

Throws:

NullArgumentException - bookQuery or bookSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - bookQuery or bookSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBookQueryFromInspector

BookQuery getBookQueryFromInspector(BookQueryInspector bookQueryInspector)

Gets an entry query from an inspector. The inspector is available from an BookSearchResults.

Parameters:

bookQueryInspector - a book query inspector

Returns:

the book query

Throws:

NullArgumentException - bookQueryInspector is null

UnsupportedException - bookQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.