OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.CommentSearchResults
Implementsosid.OsidSearchResults
Used Byosid.commenting.CommentSearchSession
Description

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

MethodgetComments
Description

Gets the comment list resulting from a search.

Returnosid.commenting.CommentList the comment list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCommentQueryInspector
Description

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

Returnosid.commenting.CommentQueryInspector the query inspector
Compliancemandatory This 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.TypecommentSearchRecordType a comment search record type
Returnosid.commenting.records.CommentSearchResultsRecord the comment search results record
ErrorsNULL_ARGUMENT commentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(commentSearchRecordType) is false
Compliancemandatory This method must be implemented.