OSID - osid.commenting.CommentQuerySession Service Interface Definition

Interface	osid.commenting.CommentQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.commenting.CommentSearchSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session provides methods for searching `Comments`. The search query is constructed using the `CommentQuery`. The book record `Type` also specifies the record for the book query. Comments may have a query record indicated by their respective record types. The query record is accessed via the `CommentQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getBookId
Description	Gets the `Book` `Id` associated with this session.
Return	`osid.id.Id`		the `Book Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBook
Description	Gets the `Book` associated with this session.
Return	`osid.commenting.Book`		the book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchComments
Description	Tests if this user can perform comment 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 not wish to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedBookView
Description	Federates the view for methods in this session. A federated view will include comments in books which are children of this book in the book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBookView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommentQuery
Description	Gets a comment query.
Return	`osid.commenting.CommentQuery`		the comment query
Compliance	`mandatory`		This method must be implemented.
Method	getCommentsByQuery
Description	Gets a list of comments matching the given search.
Parameters	`osid.commenting.CommentQuery`	`commentQuery`	the search query array
Return	`osid.commenting.CommentList`		the returned `CommentList`
Errors	NULL_ARGUMENT		`commentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.