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

Modifier and Type	Method	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(String subject)	Sets the subject line of the message.
void	setText(String text)	Sets the text of the message.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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(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(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.