OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.CommentSearch
Implementsosid.OsidSearch
Description

The search interface for governing comment searches.

MethodsearchAmongComments
Description

Execute this search among the given list of comments.

Parametersosid.id.IdListcommentIdslist of comments
ErrorsNULL_ARGUMENT commentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCommentResults
Description

Specify an ordering to the search results.

Parametersosid.commenting.CommentSearchOrdercommentSearchOrdercomment search order
ErrorsNULL_ARGUMENT commentSearchOrder is null
UNSUPPORTED commentSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommentSearchRecord
Description

Gets the comment search 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.CommentSearchRecordthe comment search record
ErrorsNULL_ARGUMENT commentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.