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.
Modifier and Type | Method and Description |
---|---|
Course |
getCourse()
Gets the canonical course associated with this course offering.
|
Id |
getCourseId()
Gets the canonical course
Id associated with this
course offering. |
CourseOfferingRecord |
getCourseOfferingRecord(Type courseOfferingRecordType)
Gets the course offering record corresponding to the given
CourseOffering record Type. |
IdList |
getCreditAmountIds()
Gets the credits in which this course can be registered.
|
GradeList |
getCreditAmounts()
Gets the credits in which this course can be registered.
|
Event |
getEvent()
Gets the calendaring event with the schedule details.
|
Id |
getEventId()
Gets the calendaring event
Id. |
IdList |
getGradingOptionIds()
Gets the various grading option
Ids available to
register in this course. |
GradeSystemList |
getGradingOptions()
Gets the various grading options available to register in this course.
|
IdList |
getInstructorIds()
Gets the instructor
Ids. |
ResourceList |
getInstructors()
Gets the instructors.
|
long |
getMaximumSeats()
Gets the maximum number of students this offering can have.
|
long |
getMinimumSeats()
Gets the minimum number of students this offering can have.
|
java.lang.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.
|
DisplayText |
getScheduleInfo()
Gets the an informational string for the course offering schedule.
|
IdList |
getSponsorIds()
Gets the sponsor
Ids. |
ResourceList |
getSponsors()
Gets the sponsors.
|
Term |
getTerm()
Gets the
Term of this offering. |
Id |
getTermId()
Gets the
Id of the Term of this
offering. |
DisplayText |
getTitle()
Gets the formal title of this course.
|
java.lang.String |
getURL()
Gets an external resource, such as a class web site, associated with
this offering.
|
boolean |
hasEvent()
Tests if a calendaring event is available for this course offering
with the schedule details.
|
boolean |
hasSponsors()
Tests if this course has sponsors.
|
boolean |
isGraded()
Tests if this course offering is graded.
|
boolean |
isSeatingLimited()
Tests if this course offering has limited seating.
|
boolean |
requiresRegistration()
Tests if this course offering requires advanced registration.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getCourseId()
Id
associated with this
course offering. Id
mandatory
- This method must be implemented. Course getCourse() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTermId()
Id
of the Term
of this
offering. Term
Id
mandatory
- This method must be implemented. Term getTerm() throws OperationFailedException
Term
of this offering.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getTitle()
mandatory
- This method must be implemented. java.lang.String getNumber()
mandatory
- This method must be implemented. IdList getInstructorIds()
Ids.
If each activity has its own
instructor, the headlining instructors may be returned. Ids
mandatory
- This method must be implemented. ResourceList getInstructors() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasSponsors()
true
if this course has sponsors, false
otherwisemandatory
- This method must be implemented. IdList getSponsorIds()
Ids.
Ids
IllegalStateException
- hasSponsors()
is
false
mandatory
- This method must be implemented. ResourceList getSponsors() throws OperationFailedException
IllegalStateException
- hasSponsors()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getCreditAmountIds()
Grades.
Ids
mandatory
- This method must be implemented. GradeList getCreditAmounts() throws OperationFailedException
Grades.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isGraded()
true
if this course is graded, false
otherwisemandatory
- This method must be implemented. IdList getGradingOptionIds()
Ids
available to
register in this course. Ids
IllegalStateException
- isGraded()
is
false
mandatory
- This method must be implemented. GradeSystemList getGradingOptions() throws OperationFailedException
IllegalStateException
- isGraded()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean requiresRegistration()
true
if this course requires advance
registration, false
otherwisemandatory
- This method must be implemented. long getMinimumSeats()
mandatory
- This method must be implemented. boolean isSeatingLimited()
true
if this seating is limited, false
otherwisemandatory
- This method must be implemented. long getMaximumSeats()
IllegalStateException
- isSeatingLimited()
is false
mandatory
- This method must be implemented. java.lang.String getURL()
mandatory
- This method must be implemented. DisplayText getScheduleInfo()
mandatory
- This method must be implemented. boolean hasEvent()
true
if this course is graded, false
otherwisemandatory
- This method must be implemented. Id getEventId()
Id.
Id
IllegalStateException
- hasEvent()
is
false
mandatory
- This method must be implemented. Event getEvent() throws OperationFailedException
IllegalStateException
- hasEvent()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CourseOfferingRecord getCourseOfferingRecord(Type courseOfferingRecordType) throws OperationFailedException
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
.courseOfferingRecordType
- the type of course offering record to
retrieveNullArgumentException
- courseOfferingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseOfferingRecordType)
is
false
mandatory
- This method must be implemented.