OSID Logo
OSID Specifications
forum package
Version 3.0.0
Interfaceosid.forum.ForumSearch
Implementsosid.OsidSearch
Used Byosid.forum.ForumSearchSession
Description

The search interface for governing forum searches.

MethodsearchAmongForums
Description

Execute this search among the given list of forums.

Parametersosid.id.IdListforumIdslist of forums
ErrorsNULL_ARGUMENTforumIds is null
CompliancemandatoryThis method must be implemented.
MethodorderForumResults
Description

Specify an ordering to the search results.

Parametersosid.forum.ForumSearchOrderforumsearchOrderforum search order
ErrorsNULL_ARGUMENTforumsearchOrder is null
UNSUPPORTEDforumsearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetForumSearchRecord
Description

Gets the forum search 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.ForumSearchRecordthe forum search record
ErrorsNULL_ARGUMENTforumSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(forumSearchRecordType) is false
CompliancemandatoryThis method must be implemented.