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;mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
Checks whether a CourseSet exists.
@param eid The enterprise id
@return Whether the object exists
*/
public boolean isCourseSetDefined(String eid);mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
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;mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
Gets all of the top level CourseSets
@return The Set of CourseSets that have no parent CourseSet
*/
public Set<CourseSet> getCourseSets();mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
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;mview refresh rate
?
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
?
timeToLiveSeconds
?
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
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);mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
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;mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
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;mview refresh rate
30
maxElementsInMemory
10000
eternal
false
timeToIdleSeconds
timeToLiveSeconds
overflowToDisk
true
algorithm(ehcache)
LFU
custom handling
/**
Gets the list of all known AcademicSessions, sorted by start date.
@return
*/
public List<AcademicSession> getAcademicSessions();