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

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

MethodgetForums
Description

Gets the forum list resulting from a search.

Returnosid.forum.ForumListthe forum list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetForumQueryInspector
Description

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

Returnosid.forum.ForumQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetForumSearchResultsRecord
Description

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

Parametersosid.type.TypeforumSearchRecordTypea forum search record type
Returnosid.forum.records.ForumSearchResultsRecordthe forum search results record
ErrorsNULL_ARGUMENT forumSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(forumSearchRecordType) is false
CompliancemandatoryThis method must be implemented.