OSID - osid.forum.PostForm Service Interface Definition

Interface	osid.forum.PostForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.forum.batch.PostBatchForm`
Used By	`osid.forum.PostAdminSession`
Description	This is the form for creating and updating `Posts`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `PostAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTimestampMetadata
Description	Gets the metadata for the timestamp.
Return	`osid.Metadata`		metadata for the timestamp
Compliance	`mandatory`		This method must be implemented.
Method	setTimestamp
Description	Sets the timestamp.
Parameters	`osid.calendaring.DateTime`	`timestamp`	the new timestamp
Errors	INVALID_ARGUMENT		`timestamp` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`timestamp` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestamp
Description	Clears the poster.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPosterMetadata
Description	Gets the metadata for the poster.
Return	`osid.Metadata`		metadata for the poster
Compliance	`mandatory`		This method must be implemented.
Method	setPoster
Description	Sets the poster.
Parameters	`osid.id.Id`	`resourceId`	the new poster
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPoster
Description	Clears the poster.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
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.
Parameters	`string`	`subjectLine`	the new subject line
Errors	INVALID_ARGUMENT		`subjectLine` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`subjectLine` is `null`
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.
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	getPostFormRecord
Description	Gets the `PostFormRecord` corresponding to the given post record `Type`.
Parameters	`osid.type.Type`	`postRecordType`	the post record type
Return	`osid.forum.records.PostFormRecord`		the post form record
Errors	NULL_ARGUMENT		`postRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(postRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.