OSID - osid.checklist.TodoForm Service Interface Definition

Interface	osid.checklist.TodoForm
Implements	`osid.OsidObjectForm`
	`osid.OsidContainableForm`
	`osid.OsidTemporalForm`
	`osid.OsidFederateableForm`
Implemented By	`osid.checklist.batch.TodoBatchForm`
Used By	`osid.checklist.TodoAdminSession`
Description	This is the form for creating and updating `Todos`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `TodoAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCompleteMetadata
Description	Gets the metadata for the completed status.
Return	`osid.Metadata`		metadata for the completed status
Compliance	`mandatory`		This method must be implemented.
Method	setComplete
Description	Sets the completed status.
Parameters	`boolean`	`complete`	the new completed status
Errors	INVALID_ARGUMENT		`complete` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearComplete
Description	Clears the complete status.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPriorityMetadata
Description	Gets the metadata for the priority.
Return	`osid.Metadata`		metadata for the priority
Compliance	`mandatory`		This method must be implemented.
Method	setPriority
Description	Sets the priority.
Parameters	`osid.type.Type`	`priorityType`	the new priority
Errors	INVALID_ARGUMENT		`priorityType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriority
Description	Clears the priority.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDueDateMetadata
Description	Gets the metadata for the due date.
Return	`osid.Metadata`		metadata for the due date
Compliance	`mandatory`		This method must be implemented.
Method	setDueDate
Description	Sets the due date.
Parameters	`osid.calendaring.DateTime`	`date`	the new due date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDate
Description	Clears the due date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDependenciesMetadata
Description	Gets the metadata for the dependencies.
Return	`osid.Metadata`		metadata for the dependencies
Compliance	`mandatory`		This method must be implemented.
Method	setDependencies
Description	Sets the dependencies.
Parameters	`osid.id.Id[]`	`todoIds`	the new dependencies
Errors	INVALID_ARGUMENT		`todoIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`todoIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDependencies
Description	Clears the dependencies.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTodoFormRecord
Description	Gets the `TodoFormRecord` corresponding to the given todo record `Type`.
Parameters	`osid.type.Type`	`todoRecordType`	the todo record type
Return	`osid.checklist.records.TodoFormRecord`		the todo form record
Errors	NULL_ARGUMENT		`todoRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(todoRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.