Interface CourseOfferingForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
CourseOfferingBatchForm
public interface CourseOfferingForm extends OsidRelationshipForm

This is the form for creating and updating CourseOfferings . Like all OsidForms , various data elements may be set here for use in the create and update methods in the CourseOfferingAdminSession . 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.

    • getInstructorsMetadata

      Metadata getInstructorsMetadata()
      Gets the metadata for the instructors.
      Returns:
      metadata for the instructors
      Compliance:
      mandatory - This method must be implemented.

    • setInstructors

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

    • clearInstructors

      void clearInstructors()
      Removes the instructors.
      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 the sponsors.
      Returns:
      metadata for the sponsors
      Compliance:
      mandatory - This method must be implemented.

    • setSponsors

      void setSponsors(Id[] sponsorIds)
      Sets the sponsors.
      Parameters:
      sponsorIds - the new sponsors
      Throws:
      InvalidArgumentException - sponsorIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - sponsorIds 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.

    • getCreditAmountsMetadata

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

    • setCreditAmounts

      void setCreditAmounts(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.

    • clearCreditAmounts

      void clearCreditAmounts()
      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 offering 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 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 the grading options.
      Returns:
      metadata for the prerequisite information
      Compliance:
      mandatory - This method must be implemented.

    • setGradingOptions

      void setGradingOptions(Id[] gradeSystemIds)
      Sets the grading options.
      Parameters:
      gradeSystemIds - the new grading options
      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 objectives
      Compliance:
      mandatory - This method must be implemented.

    • setLearningObjectives

      void setLearningObjectives(Id[] objectiveIds)
      Sets the learning objectives.
      Parameters:
      objectiveIds - the new objectives
      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.

    • getRestrictedAudiencesMetadata

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

    • setRestrictedAudiences

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

    • clearRestrictedAudiences

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

    • getRequiresRegistrationMetadata

      Metadata getRequiresRegistrationMetadata()
      Gets the metadata for requires registration flag.
      Returns:
      metadata for registration flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequiresRegistration

      void setRequiresRegistration(boolean requiresRegistration)
      Sets the requires registration flag.
      Parameters:
      requiresRegistration - the new registration flag
      Throws:
      InvalidArgumentException - requiresRegistration is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresRegistration

      void clearRequiresRegistration()
      Removes the requires registration flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumSeatsMetadata

      Metadata getMinimumSeatsMetadata()
      Gets the metadata for the minimum seats.
      Returns:
      metadata for the minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumSeats

      void setMinimumSeats(long seats)
      Sets the minimum seating count.
      Parameters:
      seats - the new minimum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumSeats

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

    • getMaximumSeatsMetadata

      Metadata getMaximumSeatsMetadata()
      Gets the metadata for the maximum seats.
      Returns:
      metadata for the maximum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMaximumSeats

      void setMaximumSeats(long seats)
      Sets the maximum seating count.
      Parameters:
      seats - the new maximum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumSeats

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

    • getURLMetadata

      Metadata getURLMetadata()
      Gets the metadata for a class url.
      Returns:
      metadata for the url
      Compliance:
      mandatory - This method must be implemented.

    • setURL

      void setURL(String url)
      Sets the url for a class web site.
      Parameters:
      url - the new url
      Throws:
      InvalidArgumentException - url is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - url is null
      Compliance:
      mandatory - This method must be implemented.

    • clearURL

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

    • getScheduleInfoMetadata

      Metadata getScheduleInfoMetadata()
      Gets the metadata for a schedule informatoin string.
      Returns:
      metadata for the schedule information
      Compliance:
      mandatory - This method must be implemented.

    • setScheduleInfo

      void setScheduleInfo(String scheduleInfo)
      Sets the schedule information. This information may be derived from the schedule and not settable here.
      Parameters:
      scheduleInfo - the new schedule info
      Throws:
      InvalidArgumentException - scheduleInfo is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - scheduleInfo is null
      Compliance:
      mandatory - This method must be implemented.

    • clearScheduleInfo

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

    • getEventMetadata

      Metadata getEventMetadata()
      Gets the metadata for manually linking an event.
      Returns:
      metadata for the event
      Compliance:
      mandatory - This method must be implemented.

    • setEvent

      void setEvent(Id eventId)
      Sets the event. This information may be derived from the activity schedules.
      Parameters:
      eventId - the new event
      Throws:
      InvalidArgumentException - eventId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - eventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEvent

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

    • getCourseOfferingFormRecord

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