org.osid.forum

Interface ReplyForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ReplyBatchForm

public interface ReplyForm
extends OsidObjectForm, OsidContainableForm, OsidSubjugateableForm

This is the form for creating and updating Reply objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ReplyAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPoster() Clears the poster.
void	clearSubjectLine() Clears the subject line.
void	clearText() Clears the text.
void	clearTimestamp() Clears the poster.
Metadata	getPosterMetadata() Gets the metadata for the poster.
ReplyFormRecord	getReplyFormRecord(Type replyRecordType) Gets the ReplyFormRecord corresponding to the given reply record Type.
Metadata	getSubjectLineMetadata() Gets the metadata for the subject line.
Metadata	getTextMetadata() Gets the metadata for the text.
Metadata	getTimestampMetadata() Gets the metadata for the timestamp.
void	setPoster(Id resourceId) Sets the poster.
void	setSubjectLine(java.lang.String subjectLine) Sets the subject line.
void	setText(java.lang.String text) Sets the text.
void	setTimestamp(DateTime timestamp) Sets the timestamp.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Method Detail

getTimestampMetadata

Metadata getTimestampMetadata()

Gets the metadata for the timestamp.

Returns:

metadata for the timestamp

Compliance:

mandatory - This method must be implemented.

setTimestamp

void setTimestamp(DateTime timestamp)

Sets the timestamp.

Parameters:

timestamp - the new timestamp

Throws:

InvalidArgumentException - timestamp is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - timestamp is null

Compliance:

mandatory - This method must be implemented.

clearTimestamp

void clearTimestamp()

Clears the poster.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPosterMetadata

Metadata getPosterMetadata()

Gets the metadata for the poster.

Returns:

metadata for the poster

Compliance:

mandatory - This method must be implemented.

setPoster

void setPoster(Id resourceId)

Sets the poster.

Parameters:

resourceId - the new poster

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearPoster

void clearPoster()

Clears the poster.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSubjectLineMetadata

Metadata getSubjectLineMetadata()

Gets the metadata for the subject line.

Returns:

metadata for the subject line

Compliance:

mandatory - This method must be implemented.

setSubjectLine

void setSubjectLine(java.lang.String subjectLine)

Sets the subject line.

Parameters:

subjectLine - the new subject line

Throws:

InvalidArgumentException - subjectLine is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - subjectLine is null

Compliance:

mandatory - This method must be implemented.

clearSubjectLine

void clearSubjectLine()

Clears the subject line.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTextMetadata

Metadata getTextMetadata()

Gets the metadata for the text.

Returns:

metadata for the text

Compliance:

mandatory - This method must be implemented.

setText

void setText(java.lang.String text)

Sets the text.

Parameters:

text - the new text

Throws:

InvalidArgumentException - text is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - text is null

Compliance:

mandatory - This method must be implemented.

clearText

void clearText()

Clears the text.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getReplyFormRecord

ReplyFormRecord getReplyFormRecord(Type replyRecordType)
                                   throws OperationFailedException

Gets the ReplyFormRecord corresponding to the given reply record Type.

Parameters:

replyRecordType - the reply record type

Returns:

the reply form record

Throws:

NullArgumentException - replyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(replyRecordType) is false

Compliance:

mandatory - This method must be implemented.