OSID Logo
OSID Specifications
forum package
Version 3.1.0
Interfaceosid.forum.ForumSearchResults
Implementsosid.OsidSearchResults
Used Byosid.forum.ForumSearchSession
Description

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

MethodgetForums
Description

Gets the forum list resulting from a search.

Returnosid.forum.ForumList the forum list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetForumQueryInspector
Description

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

Returnosid.forum.ForumQueryInspector the query inspector
Compliancemandatory This 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.TypeforumSearchRecordType a forum search record type
Returnosid.forum.records.ForumSearchResultsRecord the forum search results record
ErrorsNULL_ARGUMENT forumSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(forumSearchRecordType) is false
Compliancemandatory This method must be implemented.