| Method Summary |
|
| public Map<String, String> | findCourseOfferingRoles(String userEid)
Finds the CourseOfferings (and roles) for which a user is a member. |
| public Set<CourseOffering> | findCourseOfferings(String courseSetEid, String academicSessionEid)
Finds all of the course offerings in a course set that are current for any given
academic session (regardless of the courseOffering's start and end dates). |
| public Map<String, String> | findCourseSetRoles(String userEid)
Finds the CourseSets (and roles) for which a user is a member. |
| public List<CourseSet> | findCourseSets(String category)
Finds all course sets in a given category. |
| public Set<EnrollmentSet> | findCurrentlyEnrolledEnrollmentSets(String userEid)
Finds the set of current EnrollmentSets for which a user is enrolled but not dropped. |
| public Set<EnrollmentSet> | findCurrentlyInstructingEnrollmentSets(String userEid)
Finds the set of current EnrollmentSets for which a user is an instructor of
record. |
| public Set<Section> | findEnrolledSections(String userEid)
Finds all Sections that are linked to an EnrollmentSet for
which a user is enrolled (but not dropped). |
| public Enrollment | findEnrollment(String userEid, String enrollmentSetEid)
Finds the Enrollment for a user in an EnrollmentSet. |
| public Set<Section> | findInstructingSections(String userEid)
Finds all Sections that are linked to an EnrollmentSet for
which a user is an instructor of record. |
| public Set<Section> | findInstructingSections(String userEid, String academicSessionEid)
Finds all Sections that are linked to an EnrollmentSet for which a user is an
instructor of record and which are part of a CourseOffering in a given
AcademicSession. |
| public Map<String, String> | findSectionRoles(String userEid)
Finds the Sections (and roles) for which a user is a member. |
| public AcademicSession | getAcademicSession(String eid)
Gets a AcademicSession by its eid. |
| public List<AcademicSession> | getAcademicSessions()
Gets the list of all known AcademicSessions, sorted by start date. |
| public CanonicalCourse | getCanonicalCourse(String canonicalCourseEid)
Gets a CanonicalCourse by its eid. |
| public Set<CanonicalCourse> | getCanonicalCourses(String courseSetEid)
Gets the CanonicalCourses in a CourseSet. |
| public Set<CourseSet> | getChildCourseSets(String parentCourseSetEid)
Gets the child CourseSet from a parent CourseSet. |
| public Set<Section> | getChildSections(String parentSectionEid)
Gets the child Sections from a parent Section. |
| public CourseOffering | getCourseOffering(String courseOfferingEid)
Gets a CourseOffering by its eid. |
| public Set<Membership> | getCourseOfferingMemberships(String courseOfferingEid)
Gets the memberships directly contained by this CourseOffering.
Parameters:
courseOfferingEid - The set of memberships in this CourseOffering. |
| public Set<CourseOffering> | getCourseOfferingsInCanonicalCourse(String canonicalCourseEid)
Finds all course offerings belonging to a canonical course. |
| public Set<CourseOffering> | getCourseOfferingsInCourseSet(String courseSetEid)
Gets the CourseOfferings in a CourseSet. |
| public CourseSet | getCourseSet(String courseSetEid)
Gets a CourseSet by its eid. |
| public Set<Membership> | getCourseSetMemberships(String courseSetEid)
Gets the memberships directly contained by this CourseSet.
Parameters:
courseSetEid - The set of memberships in this CourseSet. |
| public Set<CourseSet> | getCourseSets()
|
| public List<AcademicSession> | getCurrentAcademicSessions()
Gets the list of current AcademicSessions, sorted by start date. |
| public EnrollmentSet | getEnrollmentSet(String enrollmentSetEid)
Gets an EnrollmentSet by its eid. |
| public Set<EnrollmentSet> | getEnrollmentSets(String courseOfferingEid)
|
| public Map<String, String> | getEnrollmentStatusDescriptions(Locale locale)
Gets the known enrollment status codes and descriptions for Enrollments. |
| public Set<Enrollment> | getEnrollments(String enrollmentSetEid)
|
| public Set<CanonicalCourse> | getEquivalentCanonicalCourses(String canonicalCourseEid)
Gets the equivalent CanonicalCourses. |
| public Set<CourseOffering> | getEquivalentCourseOfferings(String courseOfferingEid)
Gets any equivalent CourseOfferings. |
| public Map<String, String> | getGradingSchemeDescriptions(Locale locale)
Gets the known grading scheme codes and descriptions for Enrollments. |
| public Set<String> | getInstructorsOfRecordIds(String enrollmentSetEid)
Gets the set of user ids that are, according to the enterprise, responsible for
the EnrollmentSet. |
| public Map<String, String> | getMembershipStatusDescriptions(Locale locale)
Gets the known membership status codes and descriptions for Memberships. |
| public Section | getSection(String sectionEid)
Gets a Section by its eid. |
| public List<String> | getSectionCategories()
Gets the list of section categories defined by the institution. |
| public String | getSectionCategoryDescription(String categoryCode)
Gets the description for a category, identified by the category code, or null
if the category code can not be found. |
| public Set<Membership> | getSectionMemberships(String sectionEid)
Gets the members directly contained by this Section.
Parameters:
sectionEid - The set of members in this Section. |
| public Set<Section> | getSections(String courseOfferingEid)
|
| public boolean | isAcademicSessionDefined(String eid)
Checks whether an AcademicSession exists. |
| public boolean | isCanonicalCourseDefined(String eid)
Checks whether a CanonicalCourse exists. |
| public boolean | isCourseOfferingDefined(String eid)
Checks whether a CourseOffering exists. |
| public boolean | isCourseSetDefined(String eid)
Checks whether a CourseSet exists. |
| public boolean | isEmpty(String courseSetEid)
Determines whether a CourseSet has any CanonicalCourses or CourseSets. |
| public boolean | isEnrolled(String userEid, Set<String> enrollmentSetEids)
Determines whether a user is enrolled (and not dropped) in an EnrollmentSet. |
| public boolean | isEnrolled(String userEid, String enrollmentSetEid)
Convenience method for checking whether a user is enrolled (and not dropped)
in an EnrollmentSet. |
| public boolean | isEnrollmentSetDefined(String eid)
Checks whether an EnrollmentSet exists. |
| public boolean | isSectionDefined(String eid)
Checks whether a Section exists. |