org.osid.messaging

Interface MessageForm

All Superinterfaces:

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

All Known Subinterfaces:

MessageBatchForm

public interface MessageForm
extends OsidObjectForm

This is the form for creating and updating Messages. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the MessageAdminSession. 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	clearSubjectLine() Clears the subject line.
void	clearText() Clears the text.
MessageFormRecord	getMessageFormRecord(Type messageRecordType) Gets the MessageFormRecord corresponding to the given Message record Type.
Metadata	getSubjectLineMetadata() Gets the metadata for the subject line.
Metadata	getTextMetadata() Gets the metadata for the text.
void	setSubjectLine(java.lang.String subject) Sets the subject line of the message.
void	setText(java.lang.String text) Sets the text of the message.

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

Method Detail

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 subject)

Sets the subject line of the message.

Parameters:

subject - the subject line

Throws:

InvalidArgumentException - subject is invalid

NoAccessException - Metadata.isReadOnly() is true

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 of the message.

Parameters:

text - the text

Throws:

InvalidArgumentException - text is invalid

NoAccessException - Metadata.isReadOnly() is true

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.

getMessageFormRecord

MessageFormRecord getMessageFormRecord(Type messageRecordType)
                                       throws OperationFailedException

Gets the MessageFormRecord corresponding to the given Message record Type.

Parameters:

messageRecordType - the message record type

Returns:

the message form record

Throws:

NullArgumentException - messageRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(messageRecordType) is false

Compliance:

mandatory - This method must be implemented.