OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.PostSearch
Implementsosid.OsidSearch
Description

The search interface for governing post searches.

MethodsearchAmongPosts
Description

Execute this search among the given list of posts.

Parametersosid.id.IdListpostIdslist of posts
ErrorsNULL_ARGUMENT postIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPostResults
Description

Specify an ordering to the search results.

Parametersosid.forum.PostSearchOrderpostSearchOrderpost search order
ErrorsNULL_ARGUMENT postSearchOrder is null
UNSUPPORTED postSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPostSearchRecord
Description

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

Parametersosid.type.TypepostSearchRecordTypea post search record type
Returnosid.forum.records.PostSearchRecordthe post search record
ErrorsNULL_ARGUMENT postSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(postSearchRecordType) is false
CompliancemandatoryThis method must be implemented.