OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining bok queries.

MethodgetCommentIdTerms
Description

Gets the comment Id terms.

Returnosid.search.terms.IdTerm[]the comment Id terms
CompliancemandatoryThis method must be implemented.
MethodgetCommentTerms
Description

Gets the comment terms.

Returnosid.commenting.CommentQueryInspector[]the comment terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorBookIdTerms
Description

Gets the ancestor book Id terms.

Returnosid.search.terms.IdTerm[]the ancestor book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorBookTerms
Description

Gets the ancestor book terms.

Returnosid.commenting.BookQueryInspector[]the ancestor book terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantBookIdTerms
Description

Gets the descendant book Id terms.

Returnosid.search.terms.IdTerm[]the descendant book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantBookTerms
Description

Gets the descendant book terms.

Returnosid.commenting.BookQueryInspector[]the descendant book terms
CompliancemandatoryThis method must be implemented.
MethodgetBookQueryInspectorRecord
Description

Gets the book query inspector record corresponding to the given Book record Type.

Parametersosid.type.TypebookRecordTypea book record type
Returnosid.commenting.records.BookQueryInspectorRecordthe book query inspector record
ErrorsNULL_ARGUMENT bookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bookRecordType) is false
CompliancemandatoryThis method must be implemented.