| org.sakaiproject.coursemanagement.api.CourseManagementAdministration
All known Subclasses: org.sakaiproject.coursemanagement.impl.CourseManagementAdministrationHibernateImpl,
| CourseManagementAdministration | | public interface CourseManagementAdministration (Code) | | 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 | |
| public void | addCanonicalCourseToCourseSet(String courseSetEid, String canonicalCourseEid)
Adds a CanonicalCourse to a CourseSet. | | public void | addCourseOfferingToCourseSet(String courseSetEid, String courseOfferingEid)
Adds a CourseOffering to a CourseSet. | | public Membership | addOrUpdateCourseOfferingMembership(String userId, String role, String courseOfferingEid, String status)
Adds a user to a CourseOffering. | | public Membership | addOrUpdateCourseSetMembership(String userId, String role, String courseSetEid, String status)
Adds a user to a CourseSet. | | public Enrollment | addOrUpdateEnrollment(String userId, String enrollmentSetEid, String enrollmentStatus, String credits, String gradingScheme)
Adds an Enrollment to an EnrollmentSet. | | public Membership | addOrUpdateSectionMembership(String userId, String role, String sectionEid, String status)
Adds a user to a Section. | | public SectionCategory | addSectionCategory(String categoryCode, String categoryDescription)
| | public AcademicSession | createAcademicSession(String eid, String title, String description, Date startDate, Date endDate)
Creates a new AcademicSession. | | public CanonicalCourse | createCanonicalCourse(String eid, String title, String description)
Creates a new CanonicalCourse. | | public CourseOffering | createCourseOffering(String eid, String title, String description, String status, String academicSessionEid, String canonicalCourseEid, Date startDate, Date endDate)
Creates a new CourseOffering. | | public CourseSet | createCourseSet(String eid, String title, String description, String category, String parentCourseSetEid)
Creates a new CourseSet. | | public EnrollmentSet | createEnrollmentSet(String eid, String title, String description, String category, String defaultEnrollmentCredits, String courseOfferingEid, Set officialInstructors)
Creates a new EnrollmentSet. | | public Section | createSection(String eid, String title, String description, String category, String parentSectionEid, String courseOfferingEid, String enrollmentSetEid)
Creates a new Section. | | public Meeting | newSectionMeeting(String sectionEid, String location, Time startTime, Time finishTime, String notes)
Creates a new meeting instance. | | public void | removeAcademicSession(String eid)
Removes an academic session and all CourseOfferings associated with this
academic session. | | public void | removeCanonicalCourse(String eid)
Removes a canonical course and any course offerings associated with this
canonical course. | | public boolean | removeCanonicalCourseFromCourseSet(String courseSetEid, String canonicalCourseEid)
Removes a CanonicalCourse from a CourseSet. | | public 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. | | public boolean | removeCourseOfferingFromCourseSet(String courseSetEid, String courseOfferingEid)
Removes a CourseOffering from a CourseSet. | | public boolean | removeCourseOfferingMembership(String userId, String courseOfferingEid)
Removes a user from a CourseOffering. | | public void | removeCourseSet(String eid)
Removes a course set and any memberships in the course set. | | public boolean | removeCourseSetMembership(String userId, String courseSetEid)
Removes a user from a CourseSet. | | public boolean | removeEnrollment(String userId, String enrollmentSetEid)
Removes an Enrollment from an EnrollmentSet by setting the Enrollment to
dropped=true. | | public void | removeEnrollmentSet(String eid)
Removes an enrollment set and all associated enrollments. | | public boolean | removeEquivalency(CanonicalCourse canonicalCourse)
Removes a CanonicalCourse from its set of equivalent CanonicalCourses, if it is
a member of such a set. | | public boolean | removeEquivalency(CourseOffering courseOffering)
Removes a CourseOffering from its set of equivalent CourseOfferings, if it is
a member of such a set. | | public void | removeSection(String eid)
Removes a section and any memberships in the section. | | public boolean | removeSectionMembership(String userId, String sectionEid)
Removes a user from a Section. | | public void | setEquivalentCanonicalCourses(Set canonicalCourses)
| | public void | setEquivalentCourseOfferings(Set courseOfferings)
| | public void | updateAcademicSession(AcademicSession academicSession)
Updates an existing AcademicSession. | | public void | updateCanonicalCourse(CanonicalCourse canonicalCourse)
Updates an existing CanonicalCourse. | | public void | updateCourseOffering(CourseOffering courseOffering)
Updates an existing CourseOffering. | | public void | updateCourseSet(CourseSet courseSet)
Updates an existing CourseSet. | | public void | updateEnrollmentSet(EnrollmentSet enrollmentSet)
Updates an existing EnrollmentSet. | | public void | updateSection(Section section)
Updates an existing Section. |
| addCanonicalCourseToCourseSet | | public void addCanonicalCourseToCourseSet(String courseSetEid, String canonicalCourseEid) throws IdNotFoundException(Code) | | Adds a CanonicalCourse to a CourseSet.
Parameters:
courseSetEid -
Parameters:
canonicalCourseEid -
throws:
IdNotFoundException - |
| addCourseOfferingToCourseSet | | public void addCourseOfferingToCourseSet(String courseSetEid, String courseOfferingEid)(Code) | | Adds a CourseOffering to a CourseSet.
Parameters:
courseSetEid -
Parameters:
courseOfferingEid - |
| addOrUpdateCourseOfferingMembership | | public Membership addOrUpdateCourseOfferingMembership(String userId, String role, String courseOfferingEid, String status)(Code) | | Adds a user to a CourseOffering. If the user is already a member of the CourseOffering,
update the user's role.
Parameters:
userId -
Parameters:
role -
Parameters:
courseOfferingEid -
Parameters:
status - |
| addOrUpdateCourseSetMembership | | public Membership addOrUpdateCourseSetMembership(String userId, String role, String courseSetEid, String status) throws IdNotFoundException(Code) | | Adds a user to a CourseSet. If the user is already a member of the CourseSet,
update the user's role.
Parameters:
userId -
Parameters:
role -
Parameters:
courseSetEid -
Parameters:
status -
throws:
IdNotFoundException - If the CourseSet can not be found |
| addOrUpdateEnrollment | | public Enrollment addOrUpdateEnrollment(String userId, String enrollmentSetEid, String enrollmentStatus, String credits, String gradingScheme)(Code) | | 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 -
Parameters:
enrollmentSetEid -
Parameters:
enrollmentStatus -
Parameters:
credits -
Parameters:
gradingScheme - |
| addOrUpdateSectionMembership | | public Membership addOrUpdateSectionMembership(String userId, String role, String sectionEid, String status)(Code) | | Adds a user to a Section. If the user is already a member of the Section,
update the user's role.
Parameters:
userId -
Parameters:
role -
Parameters:
sectionEid -
Parameters:
status - |
| createEnrollmentSet | | public EnrollmentSet createEnrollmentSet(String eid, String title, String description, String category, String defaultEnrollmentCredits, String courseOfferingEid, Set officialInstructors) throws IdExistsException(Code) | | Creates a new EnrollmentSet.
Parameters:
eid -
Parameters:
title -
Parameters:
description -
Parameters:
category -
Parameters:
defaultEnrollmentCredits -
Parameters:
courseOfferingEid -
Parameters:
officialInstructors -
throws:
IdExistsException - |
| newSectionMeeting | | public Meeting newSectionMeeting(String sectionEid, String location, Time startTime, Time finishTime, String notes)(Code) | | 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
Parameters:
startTime - The time that the section starts
Parameters:
startTime - The time that the section finishes
Parameters:
notes - Optional notes about this meeting |
| removeAcademicSession | | public void removeAcademicSession(String eid)(Code) | | Removes an academic session and all CourseOfferings associated with this
academic session.
Parameters:
eid - The enterprise id of the academic session |
| removeCanonicalCourse | | public void removeCanonicalCourse(String eid)(Code) | | Removes a canonical course and any course offerings associated with this
canonical course.
Parameters:
eid - The enterprise id of the canonical course |
| removeCanonicalCourseFromCourseSet | | public boolean removeCanonicalCourseFromCourseSet(String courseSetEid, String canonicalCourseEid)(Code) | | Removes a CanonicalCourse from a CourseSet.
Parameters:
courseSetEid -
Parameters:
canonicalCourseEid - Whether the CanonicalCourse was a member of the CourseSet andwas successfully removed. |
| removeCourseOffering | | public void removeCourseOffering(String eid)(Code) | | 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 |
| removeCourseOfferingFromCourseSet | | public boolean removeCourseOfferingFromCourseSet(String courseSetEid, String courseOfferingEid)(Code) | | Removes a CourseOffering from a CourseSet.
Parameters:
courseSetEid -
Parameters:
courseOfferingEid - Whether the CourseOffering was in the CourseSet and was removed. |
| removeCourseOfferingMembership | | public boolean removeCourseOfferingMembership(String userId, String courseOfferingEid)(Code) | | Removes a user from a CourseOffering.
Parameters:
userId -
Parameters:
courseOfferingEid - Whether the user was a member of the CourseOffering and wasremoved. |
| removeCourseSet | | public void removeCourseSet(String eid)(Code) | | Removes a course set and any memberships in the course set.
Parameters:
eid - The enterprise id of the course set |
| removeCourseSetMembership | | public boolean removeCourseSetMembership(String userId, String courseSetEid)(Code) | | Removes a user from a CourseSet.
Parameters:
userId -
Parameters:
courseSetEid - Whether the user was a member of the CourseSet and was removed. |
| removeEnrollment | | public boolean removeEnrollment(String userId, String enrollmentSetEid)(Code) | | Removes an Enrollment from an EnrollmentSet by setting the Enrollment to
dropped=true.
Parameters:
userId -
Parameters:
enrollmentSetEid - Whether the enrollment existed and was removed. |
| removeEnrollmentSet | | public void removeEnrollmentSet(String eid)(Code) | | Removes an enrollment set and all associated enrollments.
Parameters:
eid - The enterprise id of the enrollment set |
| removeEquivalency | | public boolean removeEquivalency(CanonicalCourse canonicalCourse)(Code) | | Removes a CanonicalCourse from its set of equivalent CanonicalCourses, if it is
a member of such a set.
Parameters:
canonicalCourse - Whether the equivalency existed and was removed. |
| removeEquivalency | | public boolean removeEquivalency(CourseOffering courseOffering)(Code) | | Removes a CourseOffering from its set of equivalent CourseOfferings, if it is
a member of such a set.
Parameters:
courseOffering - Whether the equivalency existed and was removed. |
| removeSection | | public void removeSection(String eid)(Code) | | 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 |
| removeSectionMembership | | public boolean removeSectionMembership(String userId, String sectionEid)(Code) | | Removes a user from a Section.
Parameters:
userId -
Parameters:
sectionEid - Whether the user was a member of the Section and was removed. |
| setEquivalentCanonicalCourses | | public void setEquivalentCanonicalCourses(Set canonicalCourses)(Code) | | Creates an equivalency (cross listing) between CanonicalCourses
Parameters:
canonicalCourses - |
| setEquivalentCourseOfferings | | public void setEquivalentCourseOfferings(Set courseOfferings)(Code) | | Creates an equivalency (cross listing) betweencourseOfferings
Parameters:
courseOfferings - |
| updateAcademicSession | | public void updateAcademicSession(AcademicSession academicSession)(Code) | | Updates an existing AcademicSession.
Parameters:
academicSession - The AcademicSession to be updated |
| updateCanonicalCourse | | public void updateCanonicalCourse(CanonicalCourse canonicalCourse)(Code) | | Updates an existing CanonicalCourse.
Parameters:
canonicalCourse - |
| updateCourseOffering | | public void updateCourseOffering(CourseOffering courseOffering)(Code) | | Updates an existing CourseOffering.
Parameters:
courseOffering - |
| updateCourseSet | | public void updateCourseSet(CourseSet courseSet)(Code) | | Updates an existing CourseSet.
Parameters:
courseSet - |
| updateEnrollmentSet | | public void updateEnrollmentSet(EnrollmentSet enrollmentSet)(Code) | | Updates an existing EnrollmentSet.
Parameters:
enrollmentSet - |
| updateSection | | public void updateSection(Section section)(Code) | | Updates an existing Section.
Parameters:
section - |
|
|