public interface BookSearchSession extends BookQuerySession
This session provides methods for searching Book
objects. 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.
Modifier and Type | Method and 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.
|
canSearchBooks, getBookQuery, getBooksByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BookSearch getBookSearch()
mandatory
- This method must be implemented. BookSearchOrder getBookSearchOrder()
BookSearchOrder
is
supplied to a BookSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BookSearchResults getBooksBySearch(BookQuery bookQuery, BookSearch bookSearch) throws OperationFailedException, PermissionDeniedException
bookQuery
- the book querybookSearch
- the book searchNullArgumentException
- bookQuery
or
bookSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- bookQuery
or
bookSearch
is not of this servicemandatory
- This method must be implemented. BookQuery getBookQueryFromInspector(BookQueryInspector bookQueryInspector)
BookSearchResults.
bookQueryInspector
- a book query inspectorNullArgumentException
- bookQueryInspector
is null
UnsupportedException
- bookQueryInspector
is not of this servicemandatory
- This method must be implemented.