Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Sections Tool API

SectionService

  • Set getSections(String courseUid);
  • Set getSectionTypes(String courseUid);
  • Set getAvailableSectionLeaders(String courseUid);
  • Set getSectionLeaders(String sectionUid);
  • Set getSectionsLed(String userUid, String courseUid);
  • List getMeetings(String sectionUid);
  • List getSectionEnrollments(String sectionUid);
  • Set getSectionEnrollments(String userUid, String courseUid);

SectionCategoryService

...

While the "Section Awareness API" will feed all of Sakai's section aware tools, including the section manager tool, this API does not provide the "writable" methods needed by the section manager. This is a rough draft of the methods needed by the section manager that are not included in the "Section Awareness API".

Section Awareness methods (these are not necessary, but simply possibilities for optimization)

  • getSectionsWithInstructors(String courseId)

Student-accessible methods

  • joinSection(String sectionId)
  • dropSection(String sectionId)

Instructor / TA accessible methods

  • addSectionMembership(String userId, Role role, String sectionId)
  • dropSectionMembership(String userId, String sectionId)
  • findUsers(String searchPattern) // Global or limited to current context? TBD
  • addSection(String courseId, String title, String meetingTimes, String sectionLeaderId, int maxEnrollments, String location) // Assumes that the calendar service won't be used for setting meeting times
  • updateSection(CourseSection section)
  • disbandSection(String sectionId)
  • isSelfRegistrationAllowed(String courseId)
  • setSelfRegistrationAllowed(String courseId, boolean allowed)
  • isSectionSwitchingAllowed(String courseId)
  • setSectionSwitchingAllowed(String courseId, boolean allowed)