OSID - osid.commenting.CommentForm Service Interface Definition

Interface	osid.commenting.CommentForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.commenting.batch.CommentBatchForm`
Used By	`osid.commenting.CommentAdminSession`
Description	This is the form for creating and updating `Comments`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `CommentAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
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.
Parameters	`string`	`text`	the new text
Errors	INVALID_ARGUMENT		`text` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`text` is `null`
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	getRatingMetadata
Description	Gets the metadata for a rating.
Return	`osid.Metadata`		metadata for the rating
Compliance	`mandatory`		This method must be implemented.
Method	setRating
Description	Sets the rating.
Parameters	`osid.id.Id`	`gradeId`	the new rating
Errors	INVALID_ARGUMENT		`gradeId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRating
Description	Clears the rating.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentFormRecord
Description	Gets the `CommentFormRecord` corresponding to the given comment record `Type`.
Parameters	`osid.type.Type`	`commentRecordType`	the comment record type
Return	`osid.commenting.records.CommentFormRecord`		the comment form record
Errors	NULL_ARGUMENT		`commentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.