org.sakaiproject.coursemanagement.api
Interface CourseOffering

All Known Implementing Classes:
CourseOfferingCmImpl

public interface CourseOffering

An instance of a course.

Author:
Josh Holtzman

Method Summary
 AcademicSession getAcademicSession()
          The AcademicSession for this course offering
 String getAuthority()
          What authority defines this object?
 String getCanonicalCourseEid()
          Gets the enterprise ID of the CourseOffering's CanonicalCourse.
 Set<String> getCourseSetEids()
          Gets the Set of course set EIDs that contain this canonical course.
 String getDescription()
          Gets the description of this CourseOffering.
 String getEid()
          Gets the unique enterprise id of this CourseOffering.
 Date getEndDate()
          The date this CourseOffering ends (if any).
 Date getStartDate()
          The date this CourseOffering starts (if any).
 String getStatus()
          Gets the status of this CourseOffering.
 String getTitle()
          Gets the title of this CourseOffering.
 void setAcademicSession(AcademicSession academicSession)
           
 void setAuthority(String authority)
           
 void setDescription(String description)
           
 void setEid(String eid)
           
 void setEndDate(Date endDate)
           
 void setStartDate(Date startDate)
           
 void setStatus(String status)
           
 void setTitle(String title)
           
 

Method Detail

getEid

String getEid()
Gets the unique enterprise id of this CourseOffering.

Returns:

setEid

void setEid(String eid)

getAuthority

String getAuthority()
What authority defines this object?

Returns:

setAuthority

void setAuthority(String authority)

getTitle

String getTitle()
Gets the title of this CourseOffering.

Returns:

setTitle

void setTitle(String title)

getDescription

String getDescription()
Gets the description of this CourseOffering.

Returns:

setDescription

void setDescription(String description)

getStatus

String getStatus()
Gets the status of this CourseOffering. This might be open, closed, planned, or discontinued, for example.

Returns:

setStatus

void setStatus(String status)

getAcademicSession

AcademicSession getAcademicSession()
The AcademicSession for this course offering

Returns:

setAcademicSession

void setAcademicSession(AcademicSession academicSession)

getStartDate

Date getStartDate()
The date this CourseOffering starts (if any). Typically, a CourseOffering starts when its AcademicSession starts. Since this isn't necessarily true for every CourseOffering, the startDate can be set explicitly here.

Returns:

setStartDate

void setStartDate(Date startDate)

getEndDate

Date getEndDate()
The date this CourseOffering ends (if any). Typically, a CourseOffering ends when its AcademicSession ends. Since this isn't necessarily true for every CourseOffering, the endDate can be set explicitly here.

Returns:

setEndDate

void setEndDate(Date endDate)

getCanonicalCourseEid

String getCanonicalCourseEid()
Gets the enterprise ID of the CourseOffering's CanonicalCourse.

Returns:

getCourseSetEids

Set<String> getCourseSetEids()
Gets the Set of course set EIDs that contain this canonical course.

Returns:


Copyright © 2011 Sakai Project. All Rights Reserved.