org.osid.forum

Interface Post

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Post
extends OsidObject

A Post represents a blob of text posted to a forum by a poster. Like all OSID objects, a Post is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getPoster() Gets the poster of this post.
Id	getPosterId() Gets the poster Id of this post.
Agent	getPostingAgent() Gets the posting agent of this post.
Id	getPostingAgentId() Gets the posting agent Id of this post.
PostRecord	getPostRecord(Type postRecordType) Gets the post record corresponding to the given Post record Type.
DisplayText	getSubjectLine() Gets the subject line of this post.
DisplayText	getText() Gets the text of the post.
DateTime	getTimestamp() Gets the time of this post.

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

Method Detail

getTimestamp

DateTime getTimestamp()

Gets the time of this post.

Returns:

the time

Compliance:

mandatory - This method must be implemented.

getPosterId

Id getPosterId()

Gets the poster Id of this post.

Returns:

the poster resource Id

Compliance:

mandatory - This method must be implemented.

getPoster

Resource getPoster()
                   throws OperationFailedException

Gets the poster of this post.

Returns:

the poster resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPostingAgentId

Id getPostingAgentId()

Gets the posting agent Id of this post.

Returns:

the posting agent Id

Compliance:

mandatory - This method must be implemented.

getPostingAgent

Agent getPostingAgent()
                      throws OperationFailedException

Gets the posting agent of this post.

Returns:

the posting agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getSubjectLine

DisplayText getSubjectLine()

Gets the subject line of this post.

Returns:

the subject

Compliance:

mandatory - This method must be implemented.

getText

DisplayText getText()

Gets the text of the post.

Returns:

the entry text

Compliance:

mandatory - This method must be implemented.

getPostRecord

PostRecord getPostRecord(Type postRecordType)
                         throws OperationFailedException

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

Parameters:

postRecordType - the type of post record to retrieve

Returns:

the post record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.