OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.BookQuerySession
Implementsosid.OsidSession
Implemented Byosid.commenting.BookSearchSession
Used Byosid.commenting.CommentingManager
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.

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.

MethodcanSearchBooks
Description

Tests if this user can perform 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.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetBookQuery
Description

Gets a book query.

Returnosid.commenting.BookQuery the book query
Compliancemandatory This method must be implemented.
MethodgetBooksByQuery
Description

Gets a list of Books matching the given search.

Parametersosid.commenting.BookQuerybookQuery the book query
Returnosid.commenting.BookList the returned BookList
ErrorsNULL_ARGUMENT bookQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED bookQuery is not of this service
Compliancemandatory This method must be implemented.