Interface ForumSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ForumSearch
extends OsidSearch

The search interface for governing forum searches.

Method Summary

Modifier and Type	Method	Description
ForumSearchRecord	getForumSearchRecord(Type forumSearchRecordType)	Gets the forum search record corresponding to the given forum search record Type.
void	orderForumResults(ForumSearchOrder forumsearchOrder)	Specify an ordering to the search results.
void	searchAmongForums(IdList forumIds)	Execute this search among the given list of forums.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongForums

void searchAmongForums(IdList forumIds)

Execute this search among the given list of forums.

Parameters:

forumIds - list of forums

Throws:

NullArgumentException - forumIds is null

Compliance:

mandatory - This method must be implemented.

orderForumResults

void orderForumResults(ForumSearchOrder forumsearchOrder)

Specify an ordering to the search results.

Parameters:

forumsearchOrder - forum search order

Throws:

NullArgumentException - forumsearchOrder is null

UnsupportedException - forumsearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getForumSearchRecord

ForumSearchRecord getForumSearchRecord(Type forumSearchRecordType)
                                throws OperationFailedException

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.

Parameters:

forumSearchRecordType - a forum search record type

Returns:

the forum search record

Throws:

NullArgumentException - forumSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.