CourseManagement API Method Caching
/**
Gets a CourseSet by its eid.
@param courseSetEid The CourseSet's unique eid
@return The CourseSet
@throws IdNotFoundException If the eid is not associated with any CourseSet
*/
public CourseSet getCourseSet(String courseSetEid) throws IdNotFoundException;
/**
Checks whether a CourseSet exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isCourseSetDefined(String eid);
/**
Gets the child CourseSet from a parent CourseSet.
@param parentCourseSetEid The parent CourseSet eid
@return The Set of child CourseSets
*/
public Set<CourseSet> getChildCourseSets(String parentCourseSetEid) throws IdNotFoundException;
/**
Gets all of the top level CourseSets
@return The Set of CourseSets that have no parent CourseSet
*/
public Set<CourseSet> getCourseSets();
/**
Gets the memberships directly contained by this CourseSet.
@param courseSetEid
@return The set of memberships in this CourseSet. This is not a transitive
set.
@throws IdNotFoundException If the eid is not associated with any CourseSet
*/
public Set<Membership> getCourseSetMemberships(String courseSetEid) throws IdNotFoundException;
/**
Gets a CanonicalCourse by its eid.
@param canonicalCourseEid
@return The CanonicalCourse
@throws IdNotFoundException If the eid is not associated with any CanonicalCourse
*/
public CanonicalCourse getCanonicalCourse(String canonicalCourseEid) throws IdNotFoundException;
mview refresh rate | 30 |
maxElementsInMemory | 10000 |
eternal | false |
timeToIdleSeconds |
|
timeToLiveSeconds |
|
overflowToDisk | true |
algorithm(ehcache) | LFU |
custom handling |
|
/**
Checks whether a CanonicalCourse exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isCanonicalCourseDefined(String eid);
/**
Gets the equivalent CanonicalCourses.
@param canonicalCourseEid The eid of the CanonicalCourse to use in finding equivalents
@return The set of CanonicalCourses that are equivalent (in the Enterprise
view, not in the Java view – this is independent of CanonicalCourse.equals()).
*/
public Set<CanonicalCourse> getEquivalentCanonicalCourses(String canonicalCourseEid) throws IdNotFoundException;
/**
Gets the CanonicalCourses in a CourseSet.
@param courseSetEid The eid of the CourseSet
@return The set of CanonicalCourses in the CourseSet
@throws IdNotFoundException If the eid is not associated with any CourseSet
*/
public Set<CanonicalCourse> getCanonicalCourses(String courseSetEid) throws IdNotFoundException;
/**
Gets the list of all known AcademicSessions, sorted by start date.
@return
*/
public List<AcademicSession> getAcademicSessions();
mview refresh rate | 45 |
maxElementsInMemory | 10000 |
eternal | false |
timeToIdleSeconds |
|
timeToLiveSeconds |
|
overflowToDisk | true |
algorithm(ehcache) | LFU |
custom handling |
|
/**
Gets the list of current AcademicSessions, sorted by start date.
@return
*/
public List<AcademicSession> getCurrentAcademicSessions();
/**
Gets a AcademicSession by its eid.
@param eid
@return The AcademicSession
@throws IdNotFoundException If the eid is not associated with any AcademicSession
*/
public AcademicSession getAcademicSession(String eid) throws IdNotFoundException;
mview refresh rate | 45 |
maxElementsInMemory | 10000 |
eternal | false |
timeToIdleSeconds |
|
timeToLiveSeconds |
|
overflowToDisk | true |
algorithm(ehcache) | LFU |
custom handling |
|
/**
Checks whether an AcademicSession exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isAcademicSessionDefined(String eid);
mview refresh rate | 45 |
maxElementsInMemory | 10000 |
eternal | false |
timeToIdleSeconds |
|
timeToLiveSeconds |
|
overflowToDisk | true |
algorithm(ehcache) | LFU |
custom handling |
|
/**
Gets a CourseOffering by its eid.
@param courseOfferingEid
@return The CourseOffering
@throws IdNotFoundException If the eid is not associated with any CourseOffering
*/
public CourseOffering getCourseOffering(String courseOfferingEid) throws IdNotFoundException;
mview refresh rate | 1 day |
maxElementsInMemory | 10000 |
eternal | false |
timeToIdleSeconds | 28800 |
timeToLiveSeconds | 28800 |
overflowToDisk | true |
algorithm(ehcache) | LFU |
custom handling |
|
/**
Checks whether a CourseOffering exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isCourseOfferingDefined(String eid);
/**
Gets any equivalent CourseOfferings.
@param courseOfferingEid The eid of the CourseOffering to use in finding equivalents
@return The set of CourseOfferings that are equivalent (in the Enterprise
view, not in the Java view – this is independent of CourseOffering.equals()).
@throws IdNotFoundException If the eid is not associated with any CourseOffering
*/
public Set<CourseOffering> getEquivalentCourseOfferings(String courseOfferingEid) throws IdNotFoundException;
/**
Gets the memberships directly contained by this CourseOffering.
@param courseOfferingEid
@return The set of memberships in this CourseOffering. This is not a recursive
set of Memberships.
@throws IdNotFoundException If the eid is not associated with any CourseOffering
*/
public Set<Membership> getCourseOfferingMemberships(String courseOfferingEid) throws IdNotFoundException;
/**
Gets the CourseOfferings in a CourseSet.
@param courseSetEid The eid of the CourseSet
@return The set of CourseOfferings in the CourseSet
@throws IdNotFoundException If the eid is not associated with any CourseSet
*/
public Set<CourseOffering> getCourseOfferingsInCourseSet(String courseSetEid) throws IdNotFoundException;
/**
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).
@param courseSetEid
@param academicSessionEid
@return The set of course offerings
@throws IdNotFoundException
*/
public Set<CourseOffering> findCourseOfferings(String courseSetEid, String academicSessionEid) throws IdNotFoundException;
/**
Finds all course offerings belonging to a canonical course.
@param canonicalCourseEid The enterprise id of the canonical course
@return The set of course offerings
@throws IdNotFoundException
*/
public Set<CourseOffering> getCourseOfferingsInCanonicalCourse(String canonicalCourseEid) throws IdNotFoundException;
/**
Finds all course sets in a given category. Useful for listing the departments
@param category
@return The list of course sets, sorted by title, ascending
*/
public List<CourseSet> findCourseSets(String category);
/**
Determines whether a CourseSet has any CanonicalCourses or CourseSets.
@param courseSetEid
@return
*/
public boolean isEmpty(String courseSetEid);
/**
Gets a Section by its eid.
@param sectionEid
@return The Section
@throws IdNotFoundException If the eid is not associated with any Section
*/
public Section getSection(String sectionEid) throws IdNotFoundException;
/**
Checks whether a Section exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isSectionDefined(String eid);
/**
Gets the top-level Sections associated with a CourseOffering
@param courseOfferingEid
@return The Set of Sections
@throws IdNotFoundException If the eid is not associated with any CourseOffering
*/
public Set<Section> getSections(String courseOfferingEid) throws IdNotFoundException;/**
Gets the list of section categories defined by the institution.
@return
*/
public List<String> getSectionCategories();
/**
Gets the description for a category, identified by the category code, or null
if the category code can not be found.
@param sectionCategoryCode
@return
*/
public String getSectionCategoryDescription(String categoryCode);
/**
Gets the child Sections from a parent Section.
@param parentSectionEid The parent Section eid
@return The Set of child Sections
@throws IdNotFoundException If the eid is not associated with any parent Section
*/
public Set<Section> getChildSections(String parentSectionEid) throws IdNotFoundException;
/**
Gets the members directly contained by this Section.
@param sectionEid
@return The set of members in this Section. This is not a transitive
set.
@throws IdNotFoundException If the eid is not associated with any Section
*/
public Set<Membership> getSectionMemberships(String sectionEid) throws IdNotFoundException;
/**
Gets an EnrollmentSet by its eid.
@param enrollmentSetEid
@return The EnrollmentSet
@throws IdNotFoundException If the eid is not associated with any EnrollmentSet
*/
public EnrollmentSet getEnrollmentSet(String enrollmentSetEid) throws IdNotFoundException;
/**
Checks whether an EnrollmentSet exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isEnrollmentSetDefined(String eid);
/**
Gets the EnrollmentSets associated with a CourseOffering
@param courseOfferingEid
@return The Set of EnrollmentSets
@throws IdNotFoundException If the eid is not associated with any CourseOffering
*/
public Set<EnrollmentSet> getEnrollmentSets(String courseOfferingEid) throws IdNotFoundException;
/**
Gets the Enrollments in an EnrollmentSet (including dropped enrollments)
@param enrollmentSetEid
@return The Set of Enrollments
@throws IdNotFoundException If the eid is not associated with any EnrollmentSet
*/
public Set<Enrollment> getEnrollments(String enrollmentSetEid) throws IdNotFoundException;
/**
Gets the known enrollment status codes and descriptions for Enrollments.
@return
*/
public Map<String, String> getEnrollmentStatusDescriptions(Locale locale);
/**
Gets the known grading scheme codes and descriptions for Enrollments.
@return
*/
public Map<String, String> getGradingSchemeDescriptions(Locale locale);
/**
Gets the known membership status codes and descriptions for Memberships.
@return
*/
public Map<String, String> getMembershipStatusDescriptions(Locale locale);
/**
Gets the set of user ids that are, according to the enterprise, responsible for
the EnrollmentSet. Responsibilities usually include submitting the final grades
for students enrolled in the EnrollmentSet.
@param enrollmentSetEid
@return The set of ids for users who are responsible for this EnrollmentSet
@throws IdNotFoundException If the eid is not associated with any EnrollmentSet
*/
public Set<String> getInstructorsOfRecordIds(String enrollmentSetEid) throws IdNotFoundException;
/**
Determines whether a user is enrolled (and not dropped) in an EnrollmentSet.
This method is needed to implement Sakai's GroupProvider.
@param userEid The student's userEid
@param enrollmentSetEids The set of EnrollmentSetEids
@return
*/
public boolean isEnrolled(String userEid, Set<String> enrollmentSetEids);
/**
Convenience method for checking whether a user is enrolled (and not dropped)
in an EnrollmentSet.
@param userEid
@param enrollmentSetEid
@return */ public boolean isEnrolled(String userEid, String enrollmentSetEid);