OSID - osid.commenting.BookQuery Service Interface Definition

Interface	osid.commenting.BookQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching books. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCommentId
Description	Sets the comment `Id` for this query to match comments assigned to books.
Parameters	`osid.id.Id`	`commentId`	a comment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommentIdTerms
Description	Clears the comment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentQuery
Description	Tests if a comment query is available.
Return	`boolean`		`true` if a comment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentQuery
Description	Gets the query for a comment.
Return	`osid.commenting.CommentQuery`		the comment query
Errors	UNIMPLEMENTED		`supportsCommentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentQuery()` is `true.`
Method	matchAnyComment
Description	Matches books with any comment.
Parameters	`boolean`	`match`	`true` to match books with any comment, `false` to match books with no comments
Compliance	`mandatory`		This method must be implemented.
Method	clearCommentTerms
Description	Clears the comment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBookId
Description	Sets the book `Id` for this query to match books that have the specified book as an ancestor.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, a `false` for a negative match
Errors	NULL_ARGUMENT		`bookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBookIdTerms
Description	Clears the ancestor book `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBookQuery
Description	Tests if a `BookQuery` is available.
Return	`boolean`		`true` if a book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorBookQuery
Description	Gets the query for a book. Multiple retrievals produce a nested `OR` term.
Return	`osid.commenting.BookQuery`		the book query
Errors	UNIMPLEMENTED		`supportsAncestorBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBookQuery()` is `true.`
Method	matchAnyAncestorBook
Description	Matches books with any ancestor.
Parameters	`boolean`	`match`	`true` to match books with any ancestor, `false` to match root books
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBookTerms
Description	Clears the ancestor book terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBookId
Description	Sets the book `Id` for this query to match books that have the specified book as a descendant.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBookIdTerms
Description	Clears the descendant book `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBookQuery
Description	Tests if a `BookQuery` is available.
Return	`boolean`		`true` if a book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantBookQuery
Description	Gets the query for a book. Multiple retrievals produce a nested `OR` term.
Return	`osid.commenting.BookQuery`		the book query
Errors	UNIMPLEMENTED		`supportsDescendantBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBookQuery()` is `true.`
Method	matchAnyDescendantBook
Description	Matches books with any descendant.
Parameters	`boolean`	`match`	`true` to match books with any descendant, `false` to match leaf books
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBookTerms
Description	Clears the descendant book terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBookQueryRecord
Description	Gets the book query record corresponding to the given `Book` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`bookRecordType`	a book record type
Return	`osid.commenting.records.BookQueryRecord`		the book query record
Errors	NULL_ARGUMENT		`bookRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(bookRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.