org.sakaiproject.tool.assessment.shared.api.grading

Interface GradingSectionAwareServiceAPI

public interface GradingSectionAwareServiceAPI

The GradingServiceAPI implements the shared interface to get grading information.

Author:

Ed Smiley

Method Summary

Modifier and Type	Method and Description
List	findMatchingEnrollments(String siteId, String searchString, String optionalSectionUid, String userUid)
List<EnrollmentRecord>	getAvailableEnrollments(String siteId, String userUid)
List	getAvailableSections(String siteId, String userUid)
List	getGroupReleaseEnrollments(String Uid, String userUid, String publishedAssessmentId)
List	getSectionEnrollments(String siteId, String sectionUid, String userUid) The section enrollment list will not be returned unless the user has access to it.
List	getSectionEnrollmentsTrusted(String sectionUid)
boolean	isSectionMemberInRoleStudent(String sectionId, String studentId)
boolean	isUserAbleToEdit(String siteId, String userUid)
boolean	isUserAbleToGrade(String siteId, String userUid)
boolean	isUserAbleToGradeAll(String siteId, String userUid)
boolean	isUserAbleToGradeSection(String siteId, String userUid)
boolean	isUserGradable(String siteId, String userUid)

Method Detail

isUserAbleToGrade

boolean isUserAbleToGrade(String siteId,
                          String userUid)

isUserAbleToGradeAll

boolean isUserAbleToGradeAll(String siteId,
                             String userUid)

isUserAbleToGradeSection

boolean isUserAbleToGradeSection(String siteId,
                                 String userUid)

isUserAbleToEdit

boolean isUserAbleToEdit(String siteId,
                         String userUid)

isUserGradable

boolean isUserGradable(String siteId,
                       String userUid)

getAvailableEnrollments

List<EnrollmentRecord> getAvailableEnrollments(String siteId,
                                               String userUid)

Returns:

an EnrollmentRecord list for each student that the current user is allowed to grade.

getAvailableSections

List getAvailableSections(String siteId,
                          String userUid)

Returns:

a CourseSection list for each group that the current user belongs to.

getSectionEnrollments

List getSectionEnrollments(String siteId,
                           String sectionUid,
                           String userUid)

The section enrollment list will not be returned unless the user has access to it.

Returns:

an EnrollmentRecord list for all the students in the given group.

getSectionEnrollmentsTrusted

List getSectionEnrollmentsTrusted(String sectionUid)

findMatchingEnrollments

List findMatchingEnrollments(String siteId,
                             String searchString,
                             String optionalSectionUid,
                             String userUid)

Parameters:

searchString - a substring search for student name or display UID; the exact rules are up to the implementation

optionalSectionUid - null if the search should be made across all sections

Returns:

an EnrollmentRecord list for all matching available students.

isSectionMemberInRoleStudent

boolean isSectionMemberInRoleStudent(String sectionId,
                                     String studentId)

Parameters:

sectionId -

studentId -

Returns:

whether a student belongs to a section

getGroupReleaseEnrollments

List getGroupReleaseEnrollments(String Uid,
                                String userUid,
                                String publishedAssessmentId)

Returns:

an EnrollmentRecord list for each student that the current user is allowed to grade, who is in at least one of the release groups for this published assessment.