Interface ForumSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ForumSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ForumQueryInspector	getForumQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ForumList	getForums()	Gets the forum list resulting from a search.
ForumSearchResultsRecord	getForumSearchResultsRecord(Type forumSearchRecordType)	Gets the forum search results record corresponding to the given forum search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getForums

ForumList getForums()

Gets the forum list resulting from a search.

Returns:

the forum list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getForumQueryInspector

ForumQueryInspector getForumQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getForumSearchResultsRecord

ForumSearchResultsRecord getForumSearchResultsRecord(Type forumSearchRecordType)
                                              throws OperationFailedException

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.

Parameters:

forumSearchRecordType - a forum search record type

Returns:

the forum search results record

Throws:

NullArgumentException - forumSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.