org.sakaiproject.service.legacy.coursemanagement
Interface CourseManagementProvider

All Known Implementing Classes:
SampleCourseManagementProvider

public interface CourseManagementProvider

CourseManagementProvider is the Interface for course management information providers. These are used by a course management service to access external course information.

Version:
$Revision: 1.2 $
Author:
University of Michigan, CHEF Software Development Team

Method Summary
 Course getCourse(java.lang.String courseId)
          Access a course object.
 java.util.List getCourseMembers(java.lang.String courseId)
          Access the course members.
 java.lang.String getCourseName(java.lang.String courseId)
          Get the course name by id
 java.util.List getInstructorCourses(java.lang.String instructorId, java.lang.String termYear, java.lang.String termTerm)
          Get all the course objects in specific term and with the user as the instructor
 

Method Detail

getCourse

public Course getCourse(java.lang.String courseId)
                 throws IdUnusedException
Access a course object. Update the object with the information found.

Returns:
The course object found
Throws:
IdUnusedException

getCourseMembers

public java.util.List getCourseMembers(java.lang.String courseId)
                                throws IdUnusedException
Access the course members.

Returns:
The list of CourseMember objects
Throws:
IdUnusedException

getCourseName

public java.lang.String getCourseName(java.lang.String courseId)
                               throws IdUnusedException
Get the course name by id

Parameters:
courseId - The course Id
Returns:
The course name
Throws:
IdUnusedException

getInstructorCourses

public java.util.List getInstructorCourses(java.lang.String instructorId,
                                           java.lang.String termYear,
                                           java.lang.String termTerm)
Get all the course objects in specific term and with the user as the instructor

Parameters:
instructorId - The id for the instructor
termYear - The term year
termTerm - The term term
Returns:
The list of courses