OSID - osid.tracking.LogEntryForm Service Interface Definition

Interface	osid.tracking.LogEntryForm
Implements	`osid.OsidObjectForm`
Used By	`osid.tracking.IssueMessagingSession`
Description	This is the form for creating and updating `LogEntries` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `LogEntryAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the log entry segments.
Method	getSummaryMetadata
Description	Gets the metadata for the summary.
Return	`osid.Metadata`		metadata for the summary
Compliance	`mandatory`		This method must be implemented.
Method	setSummary
Description	Sets the summary.
Parameters	`string`	`summary`	the new summary
Errors	INVALID_ARGUMENT		`summary` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`summary` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSummary
Description	Removes the summary.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMessageMetadata
Description	Gets the metadata for the message.
Return	`osid.Metadata`		metadata for the summary
Compliance	`mandatory`		This method must be implemented.
Method	setMessage
Description	Sets the message.
Parameters	`string`	`message`	the new message
Errors	INVALID_ARGUMENT		`message` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`message` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMessage
Description	Removes the message.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryFormRecord
Description	Gets the `LogEntryFormRecord` corresponding to the given log entry record `Type` .
Parameters	`osid.type.Type`	`logEntryRecordType`	a log entry record type
Return	`osid.tracking.records.LogEntryFormRecord`		the log entry form record
Errors	NULL_ARGUMENT		`logEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(logEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.