OSID Logo
OSID Specifications
forum package
Version 3.1.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.IdListforumIds list of forums
ErrorsNULL_ARGUMENT forumIds is null
Compliancemandatory This method must be implemented.
MethodorderForumResults
Description

Specify an ordering to the search results.

Parametersosid.forum.ForumSearchOrderforumsearchOrder forum search order
ErrorsNULL_ARGUMENT forumsearchOrder is null
UNSUPPORTED forumsearchOrder is not of this service
Compliancemandatory This 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.TypeforumSearchRecordType a forum search record type
Returnosid.forum.records.ForumSearchRecord the forum search record
ErrorsNULL_ARGUMENT forumSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(forumSearchRecordType) is false
Compliancemandatory This method must be implemented.