OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ReplySearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetReplies
Description

Gets the reply list resulting from a search.

Returnosid.forum.ReplyListthe reply list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetReplyQueryInspector
Description

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

Returnosid.forum.ReplyQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetReplySearchResultsRecord
Description

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