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.
Modifier and Type | Method and Description |
---|---|
ForumRecord |
getForumRecord(Type forumRecordType)
Gets the forum record corresponding to the given
Forum
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ForumRecord getForumRecord(Type forumRecordType) throws OperationFailedException
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
.forumRecordType
- the type of forum record to retrieveNullArgumentException
- forumRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(forumRecordType)
is false
mandatory
- This method must be implemented.