org.osid.forum

Interface Forum

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Forum
extends OsidCatalog

A Forum represents a collection of posts and replies. Like all OSID objects, a Forum is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
ForumRecord	getForumRecord(Type forumRecordType) Gets the forum record corresponding to the given Forum record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getForumRecord

ForumRecord getForumRecord(Type forumRecordType)
                           throws OperationFailedException

Gets the forum record corresponding to the given Forum record Type. This method is used to retrieve an object implementing the requested record. The forumRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(forumRecordType) is true .

Parameters:

forumRecordType - the type of forum record to retrieve

Returns:

the forum record

Throws:

NullArgumentException - forumRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumRecordType) is false

Compliance:

mandatory - This method must be implemented.