OSID - osid.messaging.MessageForm Service Interface Definition

Interface	osid.messaging.MessageForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.messaging.batch.MessageBatchForm`
Used By	`osid.messaging.MessageAdminSession`
Description	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	getSubjectLineMetadata
Description	Gets the metadata for the subject line.
Return	`osid.Metadata`		metadata for the subject line
Compliance	`mandatory`		This method must be implemented.
Method	setSubjectLine
Description	Sets the subject line of the message.
Parameters	`string`	`subject`	the subject line
Errors	INVALID_ARGUMENT		`subject` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectLine
Description	Clears the subject line.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTextMetadata
Description	Gets the metadata for the text.
Return	`osid.Metadata`		metadata for the text
Compliance	`mandatory`		This method must be implemented.
Method	setText
Description	Sets the text of the message.
Parameters	`string`	`text`	the text
Errors	INVALID_ARGUMENT		`text` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearText
Description	Clears the text.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMessageFormRecord
Description	Gets the `MessageFormRecord` corresponding to the given `Message` record `Type` .
Parameters	`osid.type.Type`	`messageRecordType`	the message record type
Return	`osid.messaging.records.MessageFormRecord`		the message form record
Errors	NULL_ARGUMENT		`messageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(messageRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.