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.

Like all OsidForms, TodoForm is stateful and must not be accessed by multiple processing threads.

  • 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.