Interface TodoForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

TodoBatchForm

public interface TodoForm
extends OsidObjectForm, OsidContainableForm, OsidTemporalForm, OsidFederateableForm

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 Summary

Modifier and Type	Method	Description
void	clearComplete()	Clears the complete status.
void	clearDependencies()	Clears the dependencies.
void	clearDueDate()	Clears the due date.
void	clearPriority()	Clears the priority.
Metadata	getCompleteMetadata()	Gets the metadata for the completed status.
Metadata	getDependenciesMetadata()	Gets the metadata for the dependencies.
Metadata	getDueDateMetadata()	Gets the metadata for the due date.
Metadata	getPriorityMetadata()	Gets the metadata for the priority.
TodoFormRecord	getTodoFormRecord(Type todoRecordType)	Gets the TodoFormRecord corresponding to the given todo record Type.
void	setComplete(boolean complete)	Sets the completed status.
void	setDependencies(Id[] todoIds)	Sets the dependencies.
void	setDueDate(DateTime date)	Sets the due date.
void	setPriority(Type priorityType)	Sets the priority.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Modifier and Type	Method	Description
void	clearSequestered()	Clears the sequestered flag.
Metadata	getSequesteredMetadata()	Gets the metadata for the sequestered flag.
void	setSequestered(boolean sequestered)	Sets the sequestered flag.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getCompleteMetadata

Metadata getCompleteMetadata()

Gets the metadata for the completed status.

Returns:

metadata for the completed status

Compliance:

mandatory - This method must be implemented.

setComplete

void setComplete(boolean complete)

Sets the completed status.

Parameters:

complete - the new completed status

Throws:

InvalidArgumentException - complete is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearComplete

void clearComplete()

Clears the complete status.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPriorityMetadata

Metadata getPriorityMetadata()

Gets the metadata for the priority.

Returns:

metadata for the priority

Compliance:

mandatory - This method must be implemented.

setPriority

void setPriority(Type priorityType)

Sets the priority.

Parameters:

priorityType - the new priority

Throws:

InvalidArgumentException - priorityType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - priorityType is null

Compliance:

mandatory - This method must be implemented.

clearPriority

void clearPriority()

Clears the priority.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDueDateMetadata

Metadata getDueDateMetadata()

Gets the metadata for the due date.

Returns:

metadata for the due date

Compliance:

mandatory - This method must be implemented.

setDueDate

void setDueDate(DateTime date)

Sets the due date.

Parameters:

date - the new due date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDueDate

void clearDueDate()

Clears the due date.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDependenciesMetadata

Metadata getDependenciesMetadata()

Gets the metadata for the dependencies.

Returns:

metadata for the dependencies

Compliance:

mandatory - This method must be implemented.

setDependencies

void setDependencies(Id[] todoIds)

Sets the dependencies.

Parameters:

todoIds - the new dependencies

Throws:

InvalidArgumentException - todoIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - todoIds is null

Compliance:

mandatory - This method must be implemented.

clearDependencies

void clearDependencies()

Clears the dependencies.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTodoFormRecord

TodoFormRecord getTodoFormRecord(Type todoRecordType)
                          throws OperationFailedException

Gets the TodoFormRecord corresponding to the given todo record Type.

Parameters:

todoRecordType - the todo record type

Returns:

the todo form record

Throws:

NullArgumentException - todoRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoRecordType) is false

Compliance:

mandatory - This method must be implemented.