Interface ObjectiveForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
ObjectiveBatchForm
public interface ObjectiveForm extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Objectives. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ObjectiveAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getAssessmentMetadata

      Metadata getAssessmentMetadata()
      Gets the metadata for an assessment.
      Returns:
      metadata for the assessment
      Compliance:
      mandatory - This method must be implemented.

    • setAssessment

      void setAssessment(Id assessmentId)
      Sets the assessment.
      Parameters:
      assessmentId - the new assessment
      Throws:
      InvalidArgumentException - assessmentId is invalid
      NoAccessException - assessmentId cannot be modified
      NullArgumentException - assessmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessment

      void clearAssessment()
      Clears the assessment.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getKnowledgeCategoryMetadata

      Metadata getKnowledgeCategoryMetadata()
      Gets the metadata for a knowledge category.
      Returns:
      metadata for the knowledge category
      Compliance:
      mandatory - This method must be implemented.

    • setKnowledgeCategory

      void setKnowledgeCategory(Id gradeId)
      Sets the knowledge category.
      Parameters:
      gradeId - the new knowledge category
      Throws:
      InvalidArgumentException - gradeId is invalid
      NoAccessException - gradeId cannot be modified
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearKnowledgeCategory

      void clearKnowledgeCategory()
      Clears the knowledge category.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCognitiveProcessMetadata

      Metadata getCognitiveProcessMetadata()
      Gets the metadata for a cognitive process.
      Returns:
      metadata for the cognitive process
      Compliance:
      mandatory - This method must be implemented.

    • setCognitiveProcess

      void setCognitiveProcess(Id gradeId)
      Sets the cognitive process.
      Parameters:
      gradeId - the new cognitive process
      Throws:
      InvalidArgumentException - gradeId is invalid
      NoAccessException - gradeId cannot be modified
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCognitiveProcess

      void clearCognitiveProcess()
      Clears the cognitive process.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getObjectiveFormRecord

      ObjectiveFormRecord getObjectiveFormRecord(Type objectiveRecordType) throws OperationFailedException
      Gets the ObjectiveFormRecord corresponding to the given objective record Type.
      Parameters:
      objectiveRecordType - the objective record type
      Returns:
      the objective form record
      Throws:
      NullArgumentException - objectiveRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(objectiveRecordType) is false
      Compliance:
      mandatory - This method must be implemented.