OSID - osid.logging.LogEntryForm Service Interface Definition

Interface	osid.logging.LogEntryForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.logging.batch.LogEntryBatchForm`
Used By	`osid.logging.LogEntryAdminSession`
Used By	`osid.logging.LoggingSession`
Description	This is the form for creating and updating log entries. Like all `OsidForms`, 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.
Method	getPriorityMetadata
Description	Gets the metadata for a priority type.
Return	`osid.Metadata`		metadata for the priority
Compliance	`mandatory`		This method must be implemented.
Method	setPriority
Description	Sets the priority.
Parameters	`osid.type.Type`	`priority`	the new priority
Errors	INVALID_ARGUMENT		`priority` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`priority` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriority
Description	Removes the priority.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimestampMetadata
Description	Gets the metadata for a 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	getAgentMetadata
Description	Gets the metadata for the agent.
Return	`osid.Metadata`		metadata for the agent
Compliance	`mandatory`		This method must be implemented.
Method	setAgent
Description	Sets the agent.
Parameters	`osid.id.Id`	`agentId`	the new agent
Errors	INVALID_ARGUMENT		`agentId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`agentId` is `null`
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`	the log entry record type
Return	`osid.logging.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.