org.sakaiproject.coursemanagement.api

Interface CourseManagementAdministration

public interface CourseManagementAdministration

A service that provides for the administration of enterprise-defined course data. This service is typically not used inside Sakai, and should not be exposed until appropriate permission and reconciliation issues are solved.

Author:

Josh Holtzman

Method Summary

Methods

Modifier and Type	Method and Description
void	addCanonicalCourseToCourseSet(String courseSetEid, String canonicalCourseEid) Adds a CanonicalCourse to a CourseSet.
void	addCourseOfferingToCourseSet(String courseSetEid, String courseOfferingEid) Adds a CourseOffering to a CourseSet.
Membership	addOrUpdateCourseOfferingMembership(String userId, String role, String courseOfferingEid, String status) Adds a user to a CourseOffering.
Membership	addOrUpdateCourseSetMembership(String userId, String role, String courseSetEid, String status) Adds a user to a CourseSet.
Enrollment	addOrUpdateEnrollment(String userId, String enrollmentSetEid, String enrollmentStatus, String credits, String gradingScheme) Adds an Enrollment to an EnrollmentSet.
Membership	addOrUpdateSectionMembership(String userId, String role, String sectionEid, String status) Adds a user to a Section.
SectionCategory	addSectionCategory(String categoryCode, String categoryDescription)
AcademicSession	createAcademicSession(String eid, String title, String description, Date startDate, Date endDate) Creates a new AcademicSession.
CanonicalCourse	createCanonicalCourse(String eid, String title, String description) Creates a new CanonicalCourse.
CourseOffering	createCourseOffering(String eid, String title, String description, String status, String academicSessionEid, String canonicalCourseEid, Date startDate, Date endDate) Creates a new CourseOffering.
CourseSet	createCourseSet(String eid, String title, String description, String category, String parentCourseSetEid) Creates a new CourseSet.
EnrollmentSet	createEnrollmentSet(String eid, String title, String description, String category, String defaultEnrollmentCredits, String courseOfferingEid, Set officialInstructors) Creates a new EnrollmentSet.
Section	createSection(String eid, String title, String description, String category, String parentSectionEid, String courseOfferingEid, String enrollmentSetEid) Creates a new Section.
Meeting	newSectionMeeting(String sectionEid, String location, Time startTime, Time finishTime, String notes) Creates a new meeting instance.
void	removeAcademicSession(String eid) Removes an academic session and all CourseOfferings associated with this academic session.
void	removeCanonicalCourse(String eid) Removes a canonical course and any course offerings associated with this canonical course.
boolean	removeCanonicalCourseFromCourseSet(String courseSetEid, String canonicalCourseEid) Removes a CanonicalCourse from a CourseSet.
void	removeCourseOffering(String eid) Removes a course offering, any memberships in the course offering, as well as sections and enrollment sets that belong to this course offering.
boolean	removeCourseOfferingFromCourseSet(String courseSetEid, String courseOfferingEid) Removes a CourseOffering from a CourseSet.
boolean	removeCourseOfferingMembership(String userId, String courseOfferingEid) Removes a user from a CourseOffering.
void	removeCourseSet(String eid) Removes a course set and any memberships in the course set.
boolean	removeCourseSetMembership(String userId, String courseSetEid) Removes a user from a CourseSet.
boolean	removeEnrollment(String userId, String enrollmentSetEid) Removes an Enrollment from an EnrollmentSet by setting the Enrollment to dropped=true.
void	removeEnrollmentSet(String eid) Removes an enrollment set and all associated enrollments.
boolean	removeEquivalency(CanonicalCourse canonicalCourse) Removes a CanonicalCourse from its set of equivalent CanonicalCourses, if it is a member of such a set.
boolean	removeEquivalency(CourseOffering courseOffering) Removes a CourseOffering from its set of equivalent CourseOfferings, if it is a member of such a set.
void	removeSection(String eid) Removes a section and any memberships in the section.
boolean	removeSectionMembership(String userId, String sectionEid) Removes a user from a Section.
void	setCurrentAcademicSessions(List<String> academicSessionEids) Determines which sessions will be returned by getCurrentAcademicSessions().
void	setEquivalentCanonicalCourses(Set canonicalCourses) Creates an equivalency (cross listing) between CanonicalCourses
void	setEquivalentCourseOfferings(Set courseOfferings) Creates an equivalency (cross listing) betweencourseOfferings
void	updateAcademicSession(AcademicSession academicSession) Updates an existing AcademicSession.
void	updateCanonicalCourse(CanonicalCourse canonicalCourse) Updates an existing CanonicalCourse.
void	updateCourseOffering(CourseOffering courseOffering) Updates an existing CourseOffering.
void	updateCourseSet(CourseSet courseSet) Updates an existing CourseSet.
void	updateEnrollmentSet(EnrollmentSet enrollmentSet) Updates an existing EnrollmentSet.
void	updateSection(Section section) Updates an existing Section.

Method Detail

createAcademicSession

AcademicSession createAcademicSession(String eid,
                                    String title,
                                    String description,
                                    Date startDate,
                                    Date endDate)
                                      throws IdExistsException

Creates a new AcademicSession.

Parameters:

eid -

title -

description -

startDate -

endDate -

Throws:

IdExistsException

updateAcademicSession

void updateAcademicSession(AcademicSession academicSession)

Updates an existing AcademicSession.

Parameters:

academicSession - The AcademicSession to be updated

removeAcademicSession

void removeAcademicSession(String eid)

Removes an academic session and all CourseOfferings associated with this academic session.

Parameters:

eid - The enterprise id of the academic session

createCourseSet

CourseSet createCourseSet(String eid,
                        String title,
                        String description,
                        String category,
                        String parentCourseSetEid)
                          throws IdExistsException

Creates a new CourseSet.

Parameters:

eid -

title -

description -

category -

parentCourseSetEid - The parent CourseSet's eid, or null if none.

Throws:

IdExistsException

updateCourseSet

void updateCourseSet(CourseSet courseSet)

Updates an existing CourseSet.

Parameters:

courseSet -

removeCourseSet

void removeCourseSet(String eid)

Removes a course set and any memberships in the course set.

Parameters:

eid - The enterprise id of the course set

createCanonicalCourse

CanonicalCourse createCanonicalCourse(String eid,
                                    String title,
                                    String description)
                                      throws IdExistsException

Creates a new CanonicalCourse.

Parameters:

eid -

title -

description -

Throws:

IdExistsException

updateCanonicalCourse

void updateCanonicalCourse(CanonicalCourse canonicalCourse)

Updates an existing CanonicalCourse.

Parameters:

canonicalCourse -

addCanonicalCourseToCourseSet

void addCanonicalCourseToCourseSet(String courseSetEid,
                                 String canonicalCourseEid)
                                   throws IdNotFoundException

Adds a CanonicalCourse to a CourseSet.

Parameters:

courseSetEid -

canonicalCourseEid -

Throws:

IdNotFoundException

removeCanonicalCourseFromCourseSet

boolean removeCanonicalCourseFromCourseSet(String courseSetEid,
                                         String canonicalCourseEid)

Removes a CanonicalCourse from a CourseSet.

Parameters:

courseSetEid -

canonicalCourseEid -

Returns:

Whether the CanonicalCourse was a member of the CourseSet and was successfully removed.

setEquivalentCanonicalCourses

void setEquivalentCanonicalCourses(Set canonicalCourses)

Creates an equivalency (cross listing) between CanonicalCourses

Parameters:

canonicalCourses -

removeEquivalency

boolean removeEquivalency(CanonicalCourse canonicalCourse)

Removes a CanonicalCourse from its set of equivalent CanonicalCourses, if it is a member of such a set.

Parameters:

canonicalCourse -

Returns:

Whether the equivalency existed and was removed.

removeCanonicalCourse

void removeCanonicalCourse(String eid)

Removes a canonical course and any course offerings associated with this canonical course.

Parameters:

eid - The enterprise id of the canonical course

createCourseOffering

CourseOffering createCourseOffering(String eid,
                                  String title,
                                  String description,
                                  String status,
                                  String academicSessionEid,
                                  String canonicalCourseEid,
                                  Date startDate,
                                  Date endDate)
                                    throws IdExistsException

Creates a new CourseOffering.

Parameters:

eid -

title -

description -

academicSessionEid -

canonicalCourseEid -

startDate -

endDate -

Throws:

IdExistsException

updateCourseOffering

void updateCourseOffering(CourseOffering courseOffering)

Updates an existing CourseOffering.

Parameters:

courseOffering -

setEquivalentCourseOfferings

void setEquivalentCourseOfferings(Set courseOfferings)

Creates an equivalency (cross listing) betweencourseOfferings

Parameters:

courseOfferings -

removeEquivalency

boolean removeEquivalency(CourseOffering courseOffering)

Removes a CourseOffering from its set of equivalent CourseOfferings, if it is a member of such a set.

Parameters:

courseOffering -

Returns:

Whether the equivalency existed and was removed.

addCourseOfferingToCourseSet

void addCourseOfferingToCourseSet(String courseSetEid,
                                String courseOfferingEid)

Adds a CourseOffering to a CourseSet.

Parameters:

courseSetEid -

courseOfferingEid -

removeCourseOfferingFromCourseSet

boolean removeCourseOfferingFromCourseSet(String courseSetEid,
                                        String courseOfferingEid)

Removes a CourseOffering from a CourseSet.

Parameters:

courseSetEid -

courseOfferingEid -

Returns:

Whether the CourseOffering was in the CourseSet and was removed.

removeCourseOffering

void removeCourseOffering(String eid)

Removes a course offering, any memberships in the course offering, as well as sections and enrollment sets that belong to this course offering.

Parameters:

eid - The enterprise id of the course offering

createEnrollmentSet

EnrollmentSet createEnrollmentSet(String eid,
                                String title,
                                String description,
                                String category,
                                String defaultEnrollmentCredits,
                                String courseOfferingEid,
                                Set officialInstructors)
                                  throws IdExistsException

Creates a new EnrollmentSet.

Parameters:

eid -

title -

description -

category -

defaultEnrollmentCredits -

courseOfferingEid -

officialInstructors -

Throws:

IdExistsException

updateEnrollmentSet

void updateEnrollmentSet(EnrollmentSet enrollmentSet)

Updates an existing EnrollmentSet.

Parameters:

enrollmentSet -

removeEnrollmentSet

void removeEnrollmentSet(String eid)

Removes an enrollment set and all associated enrollments.

Parameters:

eid - The enterprise id of the enrollment set

addOrUpdateEnrollment

Enrollment addOrUpdateEnrollment(String userId,
                               String enrollmentSetEid,
                               String enrollmentStatus,
                               String credits,
                               String gradingScheme)

Adds an Enrollment to an EnrollmentSet. If the user is already enrolled in the EnrollmentSet, the Enrollment record is updated for the user.

Parameters:

userId -

enrollmentSetEid -

enrollmentStatus -

credits -

gradingScheme -

removeEnrollment

boolean removeEnrollment(String userId,
                       String enrollmentSetEid)

Removes an Enrollment from an EnrollmentSet by setting the Enrollment to dropped=true.

Parameters:

userId -

enrollmentSetEid -

Returns:

Whether the enrollment existed and was removed.

createSection

Section createSection(String eid,
                    String title,
                    String description,
                    String category,
                    String parentSectionEid,
                    String courseOfferingEid,
                    String enrollmentSetEid)
                      throws IdExistsException

Creates a new Section.

Parameters:

eid -

title -

description -

category -

parentSectionEid -

courseOfferingEid -

enrollmentSetEid -

Throws:

IdExistsException

addSectionCategory

SectionCategory addSectionCategory(String categoryCode,
                                 String categoryDescription)

newSectionMeeting

Meeting newSectionMeeting(String sectionEid,
                        String location,
                        Time startTime,
                        Time finishTime,
                        String notes)

Creates a new meeting instance. The meeting must be associated with a section and the section must be updated for the meeting to be persisted.

Parameters:

location - The location of the meeting

startTime - The time that the section starts

startTime - The time that the section finishes

notes - Optional notes about this meeting

updateSection

void updateSection(Section section)

Updates an existing Section.

Parameters:

section -

removeSection

void removeSection(String eid)

Removes a section and any memberships in the section. If an enrollment set is attached to this section, it must be removed via removeEnrollmentSet before removing the section.

Parameters:

eid - The enterprise id of the section

addOrUpdateCourseSetMembership

Membership addOrUpdateCourseSetMembership(String userId,
                                        String role,
                                        String courseSetEid,
                                        String status)
                                          throws IdNotFoundException

Adds a user to a CourseSet. If the user is already a member of the CourseSet, update the user's role.

Parameters:

userId -

role -

courseSetEid -

status -

Throws:

IdNotFoundException - If the CourseSet can not be found

removeCourseSetMembership

boolean removeCourseSetMembership(String userId,
                                String courseSetEid)

Removes a user from a CourseSet.

Parameters:

userId -

courseSetEid -

Returns:

Whether the user was a member of the CourseSet and was removed.

addOrUpdateCourseOfferingMembership

Membership addOrUpdateCourseOfferingMembership(String userId,
                                             String role,
                                             String courseOfferingEid,
                                             String status)

Adds a user to a CourseOffering. If the user is already a member of the CourseOffering, update the user's role.

Parameters:

userId -

role -

courseOfferingEid -

status -

removeCourseOfferingMembership

boolean removeCourseOfferingMembership(String userId,
                                     String courseOfferingEid)

Removes a user from a CourseOffering.

Parameters:

userId -

courseOfferingEid -

Returns:

Whether the user was a member of the CourseOffering and was removed.

addOrUpdateSectionMembership

Membership addOrUpdateSectionMembership(String userId,
                                      String role,
                                      String sectionEid,
                                      String status)

Adds a user to a Section. If the user is already a member of the Section, update the user's role.

Parameters:

userId -

role -

sectionEid -

status -

removeSectionMembership

boolean removeSectionMembership(String userId,
                              String sectionEid)

Removes a user from a Section.

Parameters:

userId -

sectionEid -

Returns:

Whether the user was a member of the Section and was removed.

setCurrentAcademicSessions

void setCurrentAcademicSessions(List<String> academicSessionEids)

Determines which sessions will be returned by getCurrentAcademicSessions().

Parameters:

academicSessionEids -