| org.sakaiproject.component.section.support.IntegrationSupport
All known Subclasses: org.sakaiproject.component.section.support.IntegrationSupportImpl,
| IntegrationSupport | | public interface IntegrationSupport (Code) | | Provides methods for manipulating users, courses, sections, and memberships.
Implementations do not provide any authorization, so they are to be used for
integration testing only.
author:
Josh Holtzman |
| Method Summary | |
| public ParticipationRecord | addSectionMembership(String userUid, String sectionUuid, Role role)
Adds a user to a section under the given role. | | public ParticipationRecord | addSiteMembership(String userUid, String siteContext, Role role)
Adds a user to a site (or "Course"). | | public Course | createCourse(String siteContext, String title, boolean externallyManaged, boolean selfRegistrationAllowed, boolean selfSwitchingAllowed)
Creates a new course. | | public CourseSection | createSection(String courseUuid, String title, String category, Integer maxEnrollments, String location, Time startTime, Time endTime, boolean monday, boolean tuesday, boolean wednesday, boolean thursday, boolean friday, boolean saturday, boolean sunday)
Creates a new section. | | public User | createUser(String userUid, String displayName, String sortName, String displayId)
Creates a new user. | | public User | findUser(String userUid)
Finds a user by their uuid. | | public Set | getAllSectionMemberships(String userUid, String siteContext)
Gets all of the section-scoped ParticipationRecords for a user in a
given site. | | public List | getAllSiteMemberships(String userUid)
Gets all of the site-scoped ParticipationRecords for a user. | | public void | removeSectionMembership(String userUid, String sectionUuid)
Removes a user from membership in a section. | | public void | removeSiteMembership(String userUid, String siteContext)
Removes a user from a site (or "Course"). |
| addSectionMembership | | public ParticipationRecord addSectionMembership(String userUid, String sectionUuid, Role role)(Code) | | Adds a user to a section under the given role.
Parameters:
userUid -
Parameters:
sectionUuid -
Parameters:
role - |
| addSiteMembership | | public ParticipationRecord addSiteMembership(String userUid, String siteContext, Role role)(Code) | | Adds a user to a site (or "Course").
Parameters:
userUid -
Parameters:
siteContext -
Parameters:
role - |
| createCourse | | public Course createCourse(String siteContext, String title, boolean externallyManaged, boolean selfRegistrationAllowed, boolean selfSwitchingAllowed)(Code) | | Creates a new course.
Parameters:
siteContext -
Parameters:
title -
Parameters:
externallyManaged -
Parameters:
selfRegistrationAllowed -
Parameters:
selfSwitchingAllowed - |
| createSection | | public CourseSection createSection(String courseUuid, String title, String category, Integer maxEnrollments, String location, Time startTime, Time endTime, boolean monday, boolean tuesday, boolean wednesday, boolean thursday, boolean friday, boolean saturday, boolean sunday)(Code) | | Creates a new section.
Parameters:
courseUuid -
Parameters:
title -
Parameters:
category -
Parameters:
maxEnrollments -
Parameters:
location -
Parameters:
startTime -
Parameters:
endTime -
Parameters:
monday -
Parameters:
tuesday -
Parameters:
wednesday -
Parameters:
thursday -
Parameters:
friday -
Parameters:
saturday -
Parameters:
sunday - |
| createUser | | public User createUser(String userUid, String displayName, String sortName, String displayId)(Code) | | Creates a new user.
Parameters:
userUid -
Parameters:
displayName -
Parameters:
sortName -
Parameters:
displayId - |
| findUser | | public User findUser(String userUid)(Code) | | Finds a user by their uuid.
Parameters:
userUid - |
| getAllSectionMemberships | | public Set getAllSectionMemberships(String userUid, String siteContext)(Code) | | Gets all of the section-scoped ParticipationRecords for a user in a
given site. The returned Set should contain either enrollment, instructor,
or TA records, since a user can not play different roles in the sections
belonging to a single site.
Parameters:
userUid -
Parameters:
siteContext - |
| getAllSiteMemberships | | public List getAllSiteMemberships(String userUid)(Code) | | Gets all of the site-scoped ParticipationRecords for a user. This can be
a mix of enrollments and instructor or TA records, since a user can play
different roles in different sites.
Parameters:
userUid - |
| removeSectionMembership | | public void removeSectionMembership(String userUid, String sectionUuid)(Code) | | Removes a user from membership in a section.
Parameters:
userUid -
Parameters:
sectionUuid - |
| removeSiteMembership | | public void removeSiteMembership(String userUid, String siteContext)(Code) | | Removes a user from a site (or "Course").
Parameters:
userUid -
Parameters:
siteContext - |
|
|