Interface CourseOffering

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface CourseOffering extends OsidRelationship

A CourseOffering represents a learning unit offered duing a Term . Scheduling information of a CourseOffering is maintained at the Activity level resulting in a composite RecurringEvent . A separate Calendar of activities can be made available through orchestration of the Calendaring OSID.

  • Method Details

    • getCourseId

      Id getCourseId()
      Gets the canonical course Id associated with this course offering.
      Returns:
      the course Id
      Compliance:
      mandatory - This method must be implemented.

    • getCourse

      Course getCourse() throws OperationFailedException
      Gets the canonical course associated with this course offering.
      Returns:
      the course
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTermId

      Id getTermId()
      Gets the Id of the Term of this offering.
      Returns:
      the Term Id
      Compliance:
      mandatory - This method must be implemented.

    • getTerm

      Term getTerm() throws OperationFailedException
      Gets the Term of this offering.
      Returns:
      the term
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTitle

      DisplayText getTitle()
      Gets the formal title of this course. It may be the same as the display name or it may be used to more formally label the course. A display name might be Physics 102 where the title is Introduction to Electromagentism.
      Returns:
      the course title
      Compliance:
      mandatory - This method must be implemented.

    • getNumber

      String getNumber()
      Gets the course number which is a label generally used to index the course offering in a catalog, such as T101 or 16.004.
      Returns:
      the course number
      Compliance:
      mandatory - This method must be implemented.

    • getInstructorIds

      IdList getInstructorIds()
      Gets the instructor Ids . If each activity has its own instructor, the headlining instructors may be returned.
      Returns:
      the instructor Ids
      Compliance:
      mandatory - This method must be implemented.

    • getInstructors

      ResourceList getInstructors() throws OperationFailedException
      Gets the instructors. If each activity has its own instructor, the headlining instructors may be returned.
      Returns:
      the sponsors
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasSponsors

      boolean hasSponsors()
      Tests if this course has sponsors.
      Returns:
      true if this course has sponsors, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorIds

      IdList getSponsorIds()
      Gets the sponsor Ids .
      Returns:
      the sponsor Ids
      Throws:
      IllegalStateException - hasSponsors() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSponsors

      ResourceList getSponsors() throws OperationFailedException
      Gets the sponsors.
      Returns:
      the sponsors
      Throws:
      IllegalStateException - hasSponsors() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCreditAmountIds

      IdList getCreditAmountIds()
      Gets the credits in which this course can be registered. The credits are expressed as Grades .
      Returns:
      the grade Ids
      Compliance:
      mandatory - This method must be implemented.

    • getCreditAmounts

      GradeList getCreditAmounts() throws OperationFailedException
      Gets the credits in which this course can be registered. The credits are expressed as Grades .
      Returns:
      the credits
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisitesInfo

      DisplayText getPrerequisitesInfo()
      Gets the an informational text for the course prerequisites.
      Returns:
      the course prerequisites
      Compliance:
      mandatory - This method must be implemented.

    • hasPrerequisites

      boolean hasPrerequisites()
      Tests if this course offering has Requisites for the course prerequisites.
      Returns:
      true if this course offering has prerequisites false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisiteIds

      IdList getPrerequisiteIds()
      Gets the requisite Ids for the course prerequisites.
      Returns:
      the requisite Ids
      Throws:
      IllegalStateException - hasPrerequisites() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisites

      RequisiteList getPrerequisites() throws OperationFailedException
      Gets the requisites for the course prerequisites. Each Requisite is an AND term such that all Requisites must be true for the prerequisites to be satisifed.
      Returns:
      the requisites
      Throws:
      IllegalStateException - hasPrerequisites() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getConcurrentCourseIds

      IdList getConcurrentCourseIds()
      Gets the Id list of courses this CourseOffering must be taken concurrently.
      Returns:
      the list of concurrent course Ids
      Compliance:
      mandatory - This method must be implemented.

    • getConcurrentCourses

      CourseList getConcurrentCourses() throws OperationFailedException
      The list of Courses this CourseOffering must be taken concurrently. Courses which can be completed independently but allowed to be taken simultaneously is described using Requisites .
      Returns:
      the list of concurrent courses
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLevelIds

      IdList getLevelIds()
      Gets the grade level Ids of this course offering. Multiple levels may exist for different systems.
      Returns:
      the returned list of grade level Ids
      Compliance:
      mandatory - This method must be implemented.

    • getLevels

      GradeList getLevels() throws OperationFailedException
      Gets the grade levels of this course offering. Multiple levels may exist for different systems.
      Returns:
      the returned list of grade levels
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isGraded

      boolean isGraded()
      Tests if this course offering is graded.
      Returns:
      true if this course is graded, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionIds

      IdList getGradingOptionIds()
      Gets the various grading option Ids available to register in this course.
      Returns:
      the returned list of grading option Ids
      Throws:
      IllegalStateException - isGraded() is false
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptions

      GradeSystemList getGradingOptions() throws OperationFailedException
      Gets the various grading options available to register in this course.
      Returns:
      the returned list of grading options
      Throws:
      IllegalStateException - isGraded() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasLearningObjectives

      boolean hasLearningObjectives()
      Tests if this course offering has associated learning objectives.
      Returns:
      true if this course offering has a learning objective, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveIds

      IdList getLearningObjectiveIds()
      Gets the overall learning objective Ids for this course offering.
      Returns:
      Ids of the l earning objectives
      Throws:
      IllegalStateException - hasLearningObjectives() is false
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectives

      ObjectiveList getLearningObjectives() throws OperationFailedException
      Gets the overall learning objectives for this course offering.
      Returns:
      the learning objectives
      Throws:
      IllegalStateException - hasLearningObjectives() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasRestrictedAudiences

      boolean hasRestrictedAudiences()
      Tests if this course offering has restricted audiences.
      Returns:
      true if this course offering has a restricted audience, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRestrictedAudienceIds

      IdList getRestrictedAudienceIds()
      Gets the restricted audience Ids for this course offering.
      Returns:
      the restricted audience Ids
      Throws:
      IllegalStateException - hasRestrictedAudiences() is false
      Compliance:
      mandatory - This method must be implemented.

    • getRestrictedAudiences

      ResourceList getRestrictedAudiences() throws OperationFailedException
      Gets the restricted audiences for this course offering.
      Returns:
      the restricted audiences
      Throws:
      IllegalStateException - hasRestrictedAudiences() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • requiresRegistration

      boolean requiresRegistration()
      Tests if this course offering requires advanced registration.
      Returns:
      true if this course requires advance registration, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumSeats

      long getMinimumSeats()
      Gets the minimum number of students this offering can have.
      Returns:
      the minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • isSeatingLimited

      boolean isSeatingLimited()
      Tests if this course offering has limited seating.
      Returns:
      true if this seating is limited, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumSeats

      long getMaximumSeats()
      Gets the maximum number of students this offering can have.
      Returns:
      the maximum seats
      Throws:
      IllegalStateException - isSeatingLimited() is false
      Compliance:
      mandatory - This method must be implemented.

    • getURL

      String getURL()
      Gets an external resource, such as a class web site, associated with this offering.
      Returns:
      a URL string
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleInfo

      DisplayText getScheduleInfo()
      Gets the an informational string for the course offering schedule.
      Returns:
      the schedule info
      Compliance:
      mandatory - This method must be implemented.

    • hasEvent

      boolean hasEvent()
      Tests if a calendaring event is available for this course offering with the schedule details.
      Returns:
      true if this course is graded, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEventId

      Id getEventId()
      Gets the calendaring event Id .
      Returns:
      the event Id
      Throws:
      IllegalStateException - hasEvent() is false
      Compliance:
      mandatory - This method must be implemented.

    • getEvent

      Event getEvent() throws OperationFailedException
      Gets the calendaring event with the schedule details.
      Returns:
      an event
      Throws:
      IllegalStateException - hasEvent() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCourseOfferingRecord

      CourseOfferingRecord getCourseOfferingRecord(Type courseOfferingRecordType) throws OperationFailedException
      Gets the course offering record corresponding to the given CourseOffering record Type . This method is used to retrieve an object implementing the requested record. The courseOfferingRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(courseOfferingRecordType) is true .
      Parameters:
      courseOfferingRecordType - the type of course offering record to retrieve
      Returns:
      the course offering record
      Throws:
      NullArgumentException - courseOfferingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseOfferingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.