OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ReplySearch
Implementsosid.OsidSearch
Description

The search interface for governing reply searches.

MethodsearchAmongReplies
Description

Execute this search among the given list of replies.

Parametersosid.id.IdListreplyIdslist of replies
ErrorsNULL_ARGUMENT replyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderReplyResults
Description

Specify an ordering to the search results.

Parametersosid.forum.ReplySearchOrderreplySearchOrderreply search order
ErrorsNULL_ARGUMENT replySearchOrder is null
UNSUPPORTED replySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetReplySearchRecord
Description

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

Parametersosid.type.TypereplySearchRecordTypea reply search record type
Returnosid.forum.records.ReplySearchRecordthe reply search record
ErrorsNULL_ARGUMENT replySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(replySearchRecordType) is false
CompliancemandatoryThis method must be implemented.