OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
commenting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.commenting.CommentQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
The comment query inspector for examining comment queries. | ||
| Method | getReferenceIdTerms | ||
| Description |
Gets the reference | ||
| Return | osid.search.terms.IdTerm[] | the reference Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentorIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentorTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentingAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the agent Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentingAgentTerms | ||
| Description |
Gets the agent terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the agent terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextTerms | ||
| Description |
Gets the text query terms. | ||
| Return | osid.search.terms.StringTerm[] | the text query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRatingIdTerms | ||
| Description |
Gets the rating | ||
| Return | osid.search.terms.IdTerm[] | the rating Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRatingTerms | ||
| Description |
Gets the rating terms. | ||
| Return | osid.grading.GradeQueryInspector[] | the rating terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBookIdTerms | ||
| Description |
Gets the book | ||
| Return | osid.search.terms.IdTerm[] | the book Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBookTerms | ||
| Description |
Gets the book terms. | ||
| Return | osid.commenting.BookQueryInspector[] | the book terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentQueryInspectorRecord | ||
| Description |
Gets the comment query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | commentRecordType | a comment record type |
| Return | osid.commenting.records.CommentQueryInspectorRecord | the comment query inspector record | |
| Errors | NULL_ARGUMENT | commentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(commentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |