org.osid.forum

Interface ForumSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface ForumSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ForumSearchOrderRecord	getForumSearchOrderRecord(Type forumRecordType) Gets the forum search order record corresponding to the given forum record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getForumSearchOrderRecord

ForumSearchOrderRecord getForumSearchOrderRecord(Type forumRecordType)
                                                 throws OperationFailedException

Gets the forum search order record corresponding to the given forum record Type. Multiple retrievals return the same underlying object.

Parameters:

forumRecordType - a forum record type

Returns:

the forum search order record

Throws:

NullArgumentException - forumRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumRecordType) is false

Compliance:

mandatory - This method must be implemented.