OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ForumQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

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.

MethodgetReplyIdTerms
Description

Gets the reply Id terms.

Returnosid.search.terms.IdTerm[]the reply Id terms
CompliancemandatoryThis method must be implemented.
MethodgetReplyTerms
Description

Gets the reply terms.

Returnosid.forum.ReplyQueryInspector[]the reply terms
CompliancemandatoryThis method must be implemented.
MethodgetPostIdTerms
Description

Gets the post Id terms.

Returnosid.search.terms.IdTerm[]the post Id terms
CompliancemandatoryThis method must be implemented.
MethodgetPostTerms
Description

Gets the post terms.

Returnosid.forum.PostQueryInspector[]the post terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorForumIdTerms
Description

Gets the ancestor forum Id terms.

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

Gets the ancestor forum terms.

Returnosid.forum.ForumQueryInspector[]the ancestor forum terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantForumIdTerms
Description

Gets the descendant forum Id terms.

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

Gets the descendant forum terms.

Returnosid.forum.ForumQueryInspector[]the descendant forum terms
CompliancemandatoryThis method must be implemented.
MethodgetForumQueryInspectorRecord
Description

Gets the forum query inspector record corresponding to the given Forum record Type.

Parametersosid.type.TypeforumRecordTypea forum record type
Returnosid.forum.records.ForumQueryInspectorRecordthe forum query inspector record
ErrorsNULL_ARGUMENT forumRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(forumRecordType) is false
CompliancemandatoryThis method must be implemented.