Interface ForumQueryInspector

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

This is the query inspector for examining forum queries. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • getReplyIdTerms

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

    • getReplyTerms

      ReplyQueryInspector[] getReplyTerms()
      Gets the reply terms.
      Returns:
      the reply terms
      Compliance:
      mandatory - This method must be implemented.

    • getPostIdTerms

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

    • getPostTerms

      PostQueryInspector[] getPostTerms()
      Gets the post terms.
      Returns:
      the post terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorForumIdTerms

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

    • getAncestorForumTerms

      ForumQueryInspector[] getAncestorForumTerms()
      Gets the ancestor forum terms.
      Returns:
      the ancestor forum terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantForumIdTerms

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

    • getDescendantForumTerms

      ForumQueryInspector[] getDescendantForumTerms()
      Gets the descendant forum terms.
      Returns:
      the descendant forum terms
      Compliance:
      mandatory - This method must be implemented.

    • getForumQueryInspectorRecord

      ForumQueryInspectorRecord getForumQueryInspectorRecord(Type forumRecordType) throws OperationFailedException
      Gets the forum query inspector record corresponding to the given Forum record Type .
      Parameters:
      forumRecordType - a forum record type
      Returns:
      the forum query inspector record
      Throws:
      NullArgumentException - forumRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(forumRecordType) is false
      Compliance:
      mandatory - This method must be implemented.