OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.CommentSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetComments
Description

Gets the comment list resulting from a search.

Returnosid.commenting.CommentListthe comment list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCommentQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.commenting.CommentQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCommentSearchResultsRecord
Description

Gets the comment search results record corresponding to the given comment search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecommentSearchRecordTypea comment search record type
Returnosid.commenting.records.CommentSearchResultsRecordthe comment search results record
ErrorsNULL_ARGUMENT commentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.