OSID - osid.commenting.BookSearchSession Service Interface Definition

Interface	osid.commenting.BookSearchSession
Implements	`osid.commenting.BookQuerySession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	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	getBookSearch
Description	Gets a book search.
Return	`osid.commenting.BookSearch`		the book search
Compliance	`mandatory`		This method must be implemented.
Method	getBookSearchOrder
Description	Gets a book search order. The `BookSearchOrder` is supplied to a `BookSearch` to specify the ordering of results.
Return	`osid.commenting.BookSearchOrder`		the book search order
Compliance	`mandatory`		This method must be implemented.
Method	getBooksBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.commenting.BookQuery`	`bookQuery`	the book query
Parameters	`osid.commenting.BookSearch`	`bookSearch`	the book search
Return	`osid.commenting.BookSearchResults`		the search results
Errors	NULL_ARGUMENT		`bookQuery` or `bookSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bookQuery` or `bookSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBookQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `BookSearchResults`.
Parameters	`osid.commenting.BookQueryInspector`	`bookQueryInspector`	a book query inspector
Return	`osid.commenting.BookQuery`		the book query
Errors	NULL_ARGUMENT		`bookQueryInspector` is `null`
Errors	UNSUPPORTED		`bookQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.