Interface BookQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface BookQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining bok queries.

  • Method Details

    • getCommentIdTerms

      IdTerm[] getCommentIdTerms()
      Gets the comment Id terms.
      Specified by:
      getCommentIdTerms in interface OsidObjectQueryInspector
      Returns:
      the comment Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getCommentTerms

      CommentQueryInspector[] getCommentTerms()
      Gets the comment terms.
      Specified by:
      getCommentTerms in interface OsidObjectQueryInspector
      Returns:
      the comment terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBookIdTerms

      IdTerm[] getAncestorBookIdTerms()
      Gets the ancestor book Id terms.
      Returns:
      the ancestor book Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBookTerms

      BookQueryInspector[] getAncestorBookTerms()
      Gets the ancestor book terms.
      Returns:
      the ancestor book terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBookIdTerms

      IdTerm[] getDescendantBookIdTerms()
      Gets the descendant book Id terms.
      Returns:
      the descendant book Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBookTerms

      BookQueryInspector[] getDescendantBookTerms()
      Gets the descendant book terms.
      Returns:
      the descendant book terms
      Compliance:
      mandatory - This method must be implemented.

    • getBookQueryInspectorRecord

      BookQueryInspectorRecord getBookQueryInspectorRecord(Type bookRecordType) throws OperationFailedException
      Gets the book query inspector record corresponding to the given Book record Type .
      Parameters:
      bookRecordType - a book record type
      Returns:
      the book query inspector record
      Throws:
      NullArgumentException - bookRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(bookRecordType) is false
      Compliance:
      mandatory - This method must be implemented.