OSID Logo
OSID Specifications
forum package
Version 3.1.0
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.IdListreplyIds list of replies
ErrorsNULL_ARGUMENT replyIds is null
Compliancemandatory This method must be implemented.
MethodorderReplyResults
Description

Specify an ordering to the search results.

Parametersosid.forum.ReplySearchOrderreplySearchOrder reply search order
ErrorsNULL_ARGUMENT replySearchOrder is null
UNSUPPORTED replySearchOrder is not of this service
Compliancemandatory This 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.TypereplySearchRecordType a reply search record type
Returnosid.forum.records.ReplySearchRecord the reply search record
ErrorsNULL_ARGUMENT replySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(replySearchRecordType) is false
Compliancemandatory This method must be implemented.