OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
forum package
Version 3.0.0
Release Candidate Preview
| Interface | osid.forum.ForumQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining forum queries.
Each method specifies an | ||
| Method | getReplyIdTerms | ||
| Description |
Gets the reply | ||
| Return | osid.search.terms.IdTerm[] | the reply Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReplyTerms | ||
| Description |
Gets the reply terms. | ||
| Return | osid.forum.ReplyQueryInspector[] | the reply terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostIdTerms | ||
| Description |
Gets the post | ||
| Return | osid.search.terms.IdTerm[] | the post Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostTerms | ||
| Description |
Gets the post terms. | ||
| Return | osid.forum.PostQueryInspector[] | the post terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorForumIdTerms | ||
| Description |
Gets the ancestor forum | ||
| Return | osid.search.terms.IdTerm[] | the ancestor forum Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorForumTerms | ||
| Description |
Gets the ancestor forum terms. | ||
| Return | osid.forum.ForumQueryInspector[] | the ancestor forum terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantForumIdTerms | ||
| Description |
Gets the descendant forum | ||
| Return | osid.search.terms.IdTerm[] | the descendant forum Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantForumTerms | ||
| Description |
Gets the descendant forum terms. | ||
| Return | osid.forum.ForumQueryInspector[] | the descendant forum terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getForumQueryInspectorRecord | ||
| Description |
Gets the forum query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | forumRecordType | a forum record type |
| Return | osid.forum.records.ForumQueryInspectorRecord | the forum query inspector record | |
| Errors | NULL_ARGUMENT | forumRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(forumRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |