OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.CommentSearch
Implementsosid.OsidSearch
Used Byosid.commenting.CommentSearchSession
Description

The search interface for governing comment searches.

MethodsearchAmongComments
Description

Execute this search among the given list of comments.

Parametersosid.id.IdListcommentIds list of comments
ErrorsNULL_ARGUMENT commentIds is null
Compliancemandatory This method must be implemented.
MethodorderCommentResults
Description

Specify an ordering to the search results.

Parametersosid.commenting.CommentSearchOrdercommentSearchOrder comment search order
ErrorsNULL_ARGUMENT commentSearchOrder is null
UNSUPPORTED commentSearchOrder is not of this service
Compliancemandatory This 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.TypecommentSearchRecordType a comment search record type
Returnosid.commenting.records.CommentSearchRecord the comment search record
ErrorsNULL_ARGUMENT commentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(commentSearchRecordType) is false
Compliancemandatory This method must be implemented.