Interface CourseForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable
All Known Subinterfaces:
CourseBatchForm
public interface CourseForm extends OsidObjectForm, OsidOperableForm

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

  • Method Details

    • getTitleMetadata

      Metadata getTitleMetadata()
      Gets the metadata for a course title.
      Returns:
      metadata for the title
      Compliance:
      mandatory - This method must be implemented.

    • setTitle

      void setTitle(String title)
      Sets the title.
      Parameters:
      title - the new title
      Throws:
      InvalidArgumentException - title is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - title is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTitle

      void clearTitle()
      Removes the title.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getNumberMetadata

      Metadata getNumberMetadata()
      Gets the metadata for a course number.
      Returns:
      metadata for the course number
      Compliance:
      mandatory - This method must be implemented.

    • setNumber

      void setNumber(String number)
      Sets the course number.
      Parameters:
      number - the new course number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - number is null
      Compliance:
      mandatory - This method must be implemented.

    • clearNumber

      void clearNumber()
      Removes the course number.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorsMetadata

      Metadata getSponsorsMetadata()
      Gets the metadata for a set of sponsors.
      Returns:
      metadata for the sponsors
      Compliance:
      mandatory - This method must be implemented.

    • setSponsors

      void setSponsors(Id[] resourceIds)
      Sets the sponsors.
      Parameters:
      resourceIds - the new sponsors
      Throws:
      InvalidArgumentException - resourceIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - resourceIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsors

      void clearSponsors()
      Removes the sponsors.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCreditsMetadata

      Metadata getCreditsMetadata()
      Gets the metadata for the credits.
      Returns:
      metadata for the credit scale
      Compliance:
      mandatory - This method must be implemented.

    • setCredits

      void setCredits(Id[] gradeIds)
      Sets the credits.
      Parameters:
      gradeIds - the new credit levels
      Throws:
      InvalidArgumentException - gradeIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCredits

      void clearCredits()
      Removes the credits.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisitesInfoMetadata

      Metadata getPrerequisitesInfoMetadata()
      Gets the metadata for a course prerequisite informational string.
      Returns:
      metadata for the prerequisite information
      Compliance:
      mandatory - This method must be implemented.

    • setPrerequisitesInfo

      void setPrerequisitesInfo(String prereqInfo)
      Sets the prerequisitie information.
      Parameters:
      prereqInfo - the new prerequisite information
      Throws:
      InvalidArgumentException - prereqInfo is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - prereqInfo is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPrerequisitesInfo

      void clearPrerequisitesInfo()
      Removes the prerequisite information.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisitesMetadata

      Metadata getPrerequisitesMetadata()
      Gets the metadata for a prerequisites.
      Returns:
      metadata for the requisites
      Compliance:
      mandatory - This method must be implemented.

    • setPrerequisites

      void setPrerequisites(Id[] requisiteIds)
      Sets the prerequisites.
      Parameters:
      requisiteIds - the new requisites
      Throws:
      InvalidArgumentException - requisiteIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - requisiteIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPrerequisites

      void clearPrerequisites()
      Removes the prerequisites.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getLevelsMetadata

      Metadata getLevelsMetadata()
      Gets the metadata for a set of grade levels.
      Returns:
      metadata for the levels
      Compliance:
      mandatory - This method must be implemented.

    • setLevels

      void setLevels(Id[] gradeIds)
      Sets the levels.
      Parameters:
      gradeIds - the new grade levels
      Throws:
      InvalidArgumentException - gradeIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLevels

      void clearLevels()
      Removes the grade levels.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionsMetadata

      Metadata getGradingOptionsMetadata()
      Gets the metadata for a set of grading options.
      Returns:
      metadata for the grading options
      Compliance:
      mandatory - This method must be implemented.

    • setGradingOptions

      void setGradingOptions(Id[] gradeSystemIds)
      Sets the grading options.
      Parameters:
      gradeSystemIds - the new grade systems
      Throws:
      InvalidArgumentException - gradeSystemIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradingOptions

      void clearGradingOptions()
      Removes the grading options.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectivesMetadata

      Metadata getLearningObjectivesMetadata()
      Gets the metadata for a set of learning objectives.
      Returns:
      metadata for the obecjtives
      Compliance:
      mandatory - This method must be implemented.

    • setLearningObjectives

      void setLearningObjectives(Id[] objectiveIds)
      Sets the learning objectives.
      Parameters:
      objectiveIds - the new obejctives
      Throws:
      InvalidArgumentException - objectiveIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - objectiveIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectives

      void clearLearningObjectives()
      Removes the learning objectives.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTargetAudiencesMetadata

      Metadata getTargetAudiencesMetadata()
      Gets the metadata for a set of target audiences.
      Returns:
      metadata for the target audiences
      Compliance:
      mandatory - This method must be implemented.

    • setTargetAudiences

      void setTargetAudiences(Id[] resourceIds)
      Sets the target audiences.
      Parameters:
      resourceIds - the new target audiences
      Throws:
      InvalidArgumentException - resourceIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - resourceIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTargetAudiences

      void clearTargetAudiences()
      Removes the target audiences.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCourseFormRecord

      CourseFormRecord getCourseFormRecord(Type courseRecordType) throws OperationFailedException
      Gets the CourseFormRecord corresponding to the given course record Type.
      Parameters:
      courseRecordType - a course record type
      Returns:
      the course form record
      Throws:
      NullArgumentException - courseRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseRecordType) is false
      Compliance:
      mandatory - This method must be implemented.