public interface BookQuerySession extends OsidSession
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.
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 |
---|---|
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchBooks()
Book
searches. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. BookQuery getBookQuery()
mandatory
- This method must be implemented. BookList getBooksByQuery(BookQuery bookQuery) throws OperationFailedException, PermissionDeniedException
Books
matching the given search.bookQuery
- the book query BookList
NullArgumentException
- bookQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- bookQuery
is not
of this servicemandatory
- This method must be implemented.