OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookQuerySession
Implementsosid.OsidSession
Description

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.

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
CompliancemandatoryThis method must be implemented.
MethodgetBookQuery
Description

Gets a book query.

Returnosid.commenting.BookQuerythe book query
CompliancemandatoryThis method must be implemented.
MethodgetBooksByQuery
Description

Gets a list of Books matching the given search.

Parametersosid.commenting.BookQuerybookQuerythe book query
Returnosid.commenting.BookListthe returned BookList
ErrorsNULL_ARGUMENT bookQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED bookQuery is not of this service
CompliancemandatoryThis method must be implemented.