AssignmentService (sakai-assignment-api 19.3 API)

All Superinterfaces:

EntityProducer
```
public interface AssignmentService
extends EntityProducer
```
AssignmentService is the service that handles assignments.

Each Assignment has an associated AssignmentContent (an AssignmentContent can belong to more the one Assignment) and a list of AssignmentSubmission (the student responses to the Assignment).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Assignment`	`addAssignment(String context)` Creates and adds a new Assignment to the service.
`Assignment`	`addDuplicateAssignment(String context, String assignmentId)` Creates and adds a new Assignment to the service which is a copy of an existing Assignment.
`AssignmentSubmission`	`addSubmission(String assignmentId, String submitter)` Adds an AssignmentSubmission
`List<String>`	`allowAddAnySubmissionUsers(String context)` Get the list of users who can add submission for at lease one assignment within the context
`boolean`	`allowAddAssignment(String context)` Check permissions for adding an Assignment.
`List<User>`	`allowAddAssignmentUsers(String context)` Get the List of Users who can add assignment
`boolean`	`allowAddSiteAssignment(String context)` Check if the user has permission to add a site-wide (not grouped) assignment.
`boolean`	`allowAddSubmission(String context)` Check permissions for add AssignmentSubmission
`boolean`	`allowAddSubmissionCheckGroups(Assignment assignment)`
`List<User>`	`allowAddSubmissionUsers(String assignmentReference)` Get the List of Users who can addSubmission() for this assignment.
`boolean`	`allowAllGroups(String context)` Check permissions for all.groups.
`boolean`	`allowGetAssignment(String assignmentReference)` Check permissions for reading an Assignment.
`boolean`	`allowGetSubmission(String submissionReference)` Check permissions for reading a Submission.
`List<User>`	`allowGradeAssignmentUsers(String assignmentReference)`
`boolean`	`allowGradeSubmission(String submissionReference)` Check permissions for grading Submission
`boolean`	`allowReceiveSubmissionNotification(String context)` Check permissions for receiving assignment submission notification email
`List<User>`	`allowReceiveSubmissionNotificationUsers(String context)` Get the List of Users who can add assignment
`boolean`	`allowRemoveAssignment(String assignmentReference)` Check permissions for removing an Assignment.
`boolean`	`allowRemoveAssignmentInContext(String context)` Check permissions for removing an Assignment.
`boolean`	`allowRemoveSubmission(String submissionReference)` Check permissions for remove Submission
`boolean`	`allowReviewService(Site site)`
`boolean`	`allowUpdateAssignment(String assignmentReference)` Check permissions for updating an Assignment.
`boolean`	`allowUpdateAssignmentInContext(String context)` Check permissions for updating an Assignment based on context.
`boolean`	`allowUpdateSubmission(String submissionReference)` Check permissions for updating Submission.
`String`	`assignmentReference(String id)` Access the internal reference which can be used to assess security clearance.
`String`	`assignmentReference(String context, String id)` Access the internal reference which can be used to assess security clearance.
`boolean`	`assignmentUsesAnonymousGrading(Assignment a)` If the assignment uses anonymous grading returns true, else false Params: AssignmentSubmission s
`boolean`	`canSubmit(Assignment assignment)` Whether the current user can submit to this assignment thereby creating a submission
`boolean`	`canSubmit(Assignment assignment, String userId)` Whether a specific user can submit to this assignment thereby creating a submission Of particular importance is whether userId is blank or not, a blank userId will perform all security checks against the current user while a non blank userId will perform all security checks against the specified user.
`int`	`countSubmissions(String assignmentRef, Boolean graded)` Count the number of submissions for a given assignment.
`Entity`	`createAssignmentEntity(Assignment assignment)`
`Entity`	`createAssignmentEntity(String assignmentId)`
`void`	`deleteAssignment(Assignment assignment)` Delete this Assignment
`void`	`deleteAssignmentAndAllReferences(Assignment assignment)` Softly delete this Assignment and remove all references to it.
`String`	`escapeInvalidCharsEntry(String accentedString)`
`boolean`	`getAllowSubmitByInstructor()` Allow that the instructor can submit an assignment on behalf of student
`Assignment`	`getAssignment(Reference reference)`
`Assignment`	`getAssignment(String assignmentId)` Access the Assignment with the specified id.
`AssignmentConstants.Status`	`getAssignmentCannonicalStatus(String assignmentId)` Retrieves the current status of the specified assignment.
`Collection<Assignment>`	`getAssignmentsForContext(String context)` Access all the Assignemnts that are not deleted and self-drafted ones
`String`	`getAssignmentStatus(String assignmentId)`
`List<ContentReviewResult>`	`getContentReviewResults(AssignmentSubmission submission)`
`String`	`getCsvSeparator()` get csv separator for exporting to CSV.
`String`	`getDeepLink(String context, String assignmentId, String userId)` Get a link directly into an assignment itself.
`String`	`getDeepLinkWithPermissions(String context, String assignmentId, boolean allowReadAssignment, boolean allowAddAssignment, boolean allowSubmitAssignment)` Get a link directly into an assignment itself, supplying the permissions to use when generating the link.
`Collection<Assignment>`	`getDeletedAssignmentsForContext(String context)` Access all the Assignments that are deleted
`String`	`getGradeDisplay(String grade, Assignment.GradeType typeOfGrade, Integer scaleFactor)`
`String`	`getGradeForSubmitter(AssignmentSubmission submission, String submitter)`
`String`	`getGradeForSubmitter(String submissionId, String submitter)`
`byte[]`	`getGradesSpreadsheet(String ref)` Access the grades spreadsheet for the reference, either for an assignment or all assignments in a context.
`Collection<Group>`	`getGroupsAllowAddAssignment(String context)` Get the collection of Groups defined for the context of this site that the end user has add assignment permissions in.
`Collection<Group>`	`getGroupsAllowGradeAssignment(String assignmentReference)` Get the collection of Groups defined for the context of this site that the end user has grade assignment permissions in.
`Collection<Group>`	`getGroupsAllowRemoveAssignment(String context)`
`Collection<Group>`	`getGroupsAllowUpdateAssignment(String context)` Get the collection of Groups defined for the context of this site that the end user has update assignment permissions in.
`String`	`getMaxPointGradeDisplay(int factor, int maxGradePoint)`
`Integer`	`getScaleFactor()` Get Scale Factor from the property assignment.grading.decimals
`List<User>`	`getSortedGroupUsers(Group g)` Return a sorted list of users representing a group.
`AssignmentSubmission`	`getSubmission(List<AssignmentSubmission> submissions, User person)` Deprecated.
`AssignmentSubmission`	`getSubmission(String submissionId)` Access the AssignmentSubmission with the specified id.
`AssignmentSubmission`	`getSubmission(String assignmentReference, String submitterId)` Access a User or Group's AssignmentSubmission to a particular Assignment.
`AssignmentSubmission`	`getSubmission(String assignmentId, User person)` Access a User's AssignmentSubmission to a particular Assignment.
`Set<AssignmentSubmission>`	`getSubmissions(Assignment assignment)` Get the submissions for an assignment.
`String`	`getSubmissionStatus(String submissionId)`
`Optional<AssignmentSubmissionSubmitter>`	`getSubmissionSubmittee(AssignmentSubmission submission)`
`Collection<User>`	`getSubmissionSubmittersAsUsers(AssignmentSubmission submission)`
`void`	`getSubmissionsZip(OutputStream out, String ref, String queryString)` Access the submissions zip for the assignment reference.
`Map<Assignment,List<String>>`	`getSubmittableAssignmentsForContext(String context)` Retrieve a map of Assignments to a list of User IDs of those who may submit each assignment.
`Collection<Group>`	`getSubmitterGroupList(String searchFilterOnly, String allOrOneGroup, String searchString, String aRef, String contextString)`
`List<String>`	`getSubmitterIdList(String searchFilterOnly, String allOrOneGroup, String search, String aRef, String contextString)` get appropriate submitter id list with group choice and site id
`Map<User,AssignmentSubmission>`	`getSubmitterMap(String searchFilterOnly, String allOrOneGroup, String search, String aRef, String contextString)` Alternative to getSubmittedIdList which returns full user and submissions, since submitterIdList retrieves them anyway
`String`	`getToolTitle()` This will return the internationalized title of the tool.
`String`	`getUsersLocalDateTimeString(Instant date)`
`String`	`getXmlAssignment(Assignment assignment)`
`boolean`	`isContentReviewVisibleForSubmission(AssignmentSubmission submission)` Determines whether it is appropriate to display the content review results for a submission.
`boolean`	`isPeerAssessmentClosed(Assignment assignment)` peer assessment is set for this assignment but the current time is passed the peer assessment period
`boolean`	`isPeerAssessmentOpen(Assignment assignment)` peer assessment is set for this assignment and the current time falls between the assignment close time and the peer asseessment period time
`boolean`	`isPeerAssessmentPending(Assignment assignment)` peer assessment is set for this assignment but the close time hasn't passed
`Assignment`	`mergeAssignment(Element el)` Add a new assignment to the directory, from a definition in XML.
`AssignmentSubmission`	`mergeSubmission(Element el)` Add a new AssignmentSubmission to the directory, from a definition in XML.
`void`	`postReviewableSubmissionAttachments(AssignmentSubmission submission)`
`void`	`removeSubmission(AssignmentSubmission submission)` Removes an AssignmentSubmission and all references to it
`void`	`resetAssignment(Assignment assignment)`
`void`	`softDeleteAssignment(Assignment assignment)` Softly delete this Assignment
`String`	`submissionReference(String context, String id, String assignmentId)` Access the internal reference which can be used to access the resource from within the system.
`void`	`updateAssignment(Assignment assignment)`
`void`	`updateSubmission(AssignmentSubmission submission)`

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer
archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getHttpAccess, getLabel, merge, parseEntityReference, willArchiveMerge

- Method Detail
  - createAssignmentEntity
```
Entity createAssignmentEntity(String assignmentId)
```
  - createAssignmentEntity
```
Entity createAssignmentEntity(Assignment assignment)
```
  - allowReceiveSubmissionNotification
```
boolean allowReceiveSubmissionNotification(String context)
```
    Check permissions for receiving assignment submission notification email
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed to receive the email, false if not.
  - allowReceiveSubmissionNotificationUsers
```
List<User> allowReceiveSubmissionNotificationUsers(String context)
```
    Get the List of Users who can add assignment
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    the List (User) of users who are allowed to receive the email, false if not.
  - getGroupsAllowRemoveAssignment
```
Collection<Group> getGroupsAllowRemoveAssignment(String context)
```
    Parameters:
    
    context -
    
    Returns:
  - allowAddAssignment
```
boolean allowAddAssignment(String context)
```
    Check permissions for adding an Assignment.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed to add an Assignment, false if not.
  - allowUpdateAssignmentInContext
```
boolean allowUpdateAssignmentInContext(String context)
```
    Check permissions for updating an Assignment based on context.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed to update assignments, false if not.
  - allowAddSiteAssignment
```
boolean allowAddSiteAssignment(String context)
```
    Check if the user has permission to add a site-wide (not grouped) assignment.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    true if the user has permission to add a channel-wide (not grouped) assignment.
  - allowRemoveAssignmentInContext
```
boolean allowRemoveAssignmentInContext(String context)
```
    Check permissions for removing an Assignment.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed to remove an Assignment, false if not.
  - allowAllGroups
```
boolean allowAllGroups(String context)
```
    Check permissions for all.groups.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed all.groups, false if not.
  - allowGetAssignment
```
boolean allowGetAssignment(String assignmentReference)
```
    Check permissions for reading an Assignment.
    
    Parameters:
    
    assignmentReference - - The Assignment's reference.
    
    Returns:
    
    True if the current User is allowed to get the Assignment, false if not.
  - getGroupsAllowAddAssignment
```
Collection<Group> getGroupsAllowAddAssignment(String context)
```
    Get the collection of Groups defined for the context of this site that the end user has add assignment permissions in.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    The Collection (Group) of groups defined for the context of this site that the end user has add assignment permissions in, empty if none.
  - getGroupsAllowUpdateAssignment
```
Collection<Group> getGroupsAllowUpdateAssignment(String context)
```
    Get the collection of Groups defined for the context of this site that the end user has update assignment permissions in.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    The Collection (Group) of groups defined for the context of this site that the end user has update assignment permissions in, empty if none.
  - getGroupsAllowGradeAssignment
```
Collection<Group> getGroupsAllowGradeAssignment(String assignmentReference)
```
    Get the collection of Groups defined for the context of this site that the end user has grade assignment permissions in.
    
    Returns:
    
    The Collection (Group) of groups defined for the context of this site that the end user has grade assignment permissions in, empty if none.
  - allowUpdateAssignment
```
boolean allowUpdateAssignment(String assignmentReference)
```
    Check permissions for updating an Assignment.
    
    Parameters:
    
    assignmentReference - - The Assignment's reference.
    
    Returns:
    
    True if the current User is allowed to update the Assignment, false if not.
  - allowRemoveAssignment
```
boolean allowRemoveAssignment(String assignmentReference)
```
    Check permissions for removing an Assignment.
    
    Parameters:
    
    assignmentReference - - The Assignment's reference.
    
    Returns:
    
    True if the current User is allowed to remove the Assignment, false if not.
  - allowAddSubmission
```
boolean allowAddSubmission(String context)
```
    Check permissions for add AssignmentSubmission
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    True if the current User is allowed to add an AssignmentSubmission, false if not.
  - allowAddSubmissionCheckGroups
```
boolean allowAddSubmissionCheckGroups(Assignment assignment)
```
    Parameters:
    
    assignment - - An Assignment object. Needed for the groups to be checked.
    
    Returns:
  - allowAddSubmissionUsers
```
List<User> allowAddSubmissionUsers(String assignmentReference)
```
    Get the List of Users who can addSubmission() for this assignment.
    
    Parameters:
    
    assignmentReference - - a reference to an assignment
    
    Returns:
    
    the List (User) of users who can addSubmission() for this assignment.
  - allowGradeAssignmentUsers
```
List<User> allowGradeAssignmentUsers(String assignmentReference)
```
  - allowAddAnySubmissionUsers
```
List<String> allowAddAnySubmissionUsers(String context)
```
    Get the list of users who can add submission for at lease one assignment within the context
    
    Parameters:
    
    context - the context string
    
    Returns:
    
    the list of user (ids)
  - allowAddAssignmentUsers
```
List<User> allowAddAssignmentUsers(String context)
```
    Get the List of Users who can add assignment
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    the List (User) of users who can add assignment
  - allowGetSubmission
```
boolean allowGetSubmission(String submissionReference)
```
    Check permissions for reading a Submission.
    
    Parameters:
    
    submissionReference - - The Submission's reference.
    
    Returns:
    
    True if the current User is allowed to get the AssignmentSubmission, false if not.
  - allowUpdateSubmission
```
boolean allowUpdateSubmission(String submissionReference)
```
    Check permissions for updating Submission.
    
    Parameters:
    
    submissionReference - - The Submission's reference.
    
    Returns:
    
    True if the current User is allowed to update the AssignmentSubmission, false if not.
  - allowRemoveSubmission
```
boolean allowRemoveSubmission(String submissionReference)
```
    Check permissions for remove Submission
    
    Parameters:
    
    submissionReference - - The Submission's reference.
    
    Returns:
    
    True if the current User is allowed to remove the AssignmentSubmission, false if not.
  - allowReviewService
```
boolean allowReviewService(Site site)
```
  - allowGradeSubmission
```
boolean allowGradeSubmission(String submissionReference)
```
    Check permissions for grading Submission
    
    Parameters:
    
    submissionReference - - The Submission's reference.
    
    Returns:
    
    True if the current User is allowed to grade the AssignmentSubmission, false if not.
  - addAssignment
```
Assignment addAssignment(String context)
                  throws PermissionException
```
    Creates and adds a new Assignment to the service.
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    AssignmentEdit The new Assignment object.
    
    Throws:
    
    IdInvalidException - if the id contains prohibited characers.
    
    IdUsedException - if the id is already used in the service.
    
    PermissionException - if current User does not have permission to do this.
  - mergeAssignment
```
Assignment mergeAssignment(Element el)
                    throws IdInvalidException,
                           IdUsedException,
                           PermissionException
```
    Add a new assignment to the directory, from a definition in XML. Must commitEdit() to make official, or cancelEdit() when done!
    
    Parameters:
    
    el - The XML DOM Element defining the assignment.
    
    Returns:
    
    A locked AssignmentEdit object (reserving the id).
    
    Throws:
    
    IdInvalidException - if the assignment id is invalid.
    
    IdUsedException - if the assignment id is already used.
    
    PermissionException - if the current user does not have permission to add an assignnment.
  - addDuplicateAssignment
```
Assignment addDuplicateAssignment(String context,
                                  String assignmentId)
                           throws IdInvalidException,
                                  PermissionException,
                                  IdUsedException,
                                  IdUnusedException
```
    Creates and adds a new Assignment to the service which is a copy of an existing Assignment.
    
    Parameters:
    
    context - The context for the new assignment
    
    assignmentId - The id of the Assignment to be duplicated.
    
    Returns:
    
    The new Assignment object, or null if the original Assignment does not exist.
    
    Throws:
    
    PermissionException - if current User does not have permission to do this.
    
    IdInvalidException
    
    IdUsedException
    
    IdUnusedException
  - deleteAssignment
```
void deleteAssignment(Assignment assignment)
               throws PermissionException
```
    Delete this Assignment
    
    Parameters:
    
    assignment - - The Assignment to delete.
    
    Throws:
    
    PermissionException - if current User does not have permission to do this.
  - softDeleteAssignment
```
void softDeleteAssignment(Assignment assignment)
                   throws PermissionException
```
    Softly delete this Assignment
    
    Parameters:
    
    assignment - - The Assignment to softly delete.
    
    Throws:
    
    PermissionException - if current User does not have permission to do this.
  - deleteAssignmentAndAllReferences
```
void deleteAssignmentAndAllReferences(Assignment assignment)
                               throws PermissionException
```
    Softly delete this Assignment and remove all references to it.
    
    Parameters:
    
    assignment - - The Assignment to softly delete.
    
    Throws:
    
    PermissionException - if current User does not have permission to do this.
  - addSubmission
```
AssignmentSubmission addSubmission(String assignmentId,
                                   String submitter)
                            throws PermissionException
```
    Adds an AssignmentSubmission
    
    Parameters:
    
    assignmentId - The assignment id
    
    submitter - The submitter id
    
    Returns:
    
    The new AssignmentSubmission.
    
    Throws:
    
    IdInvalidException - if the submission id is invalid.
    
    IdUsedException - if the submission id is already used.
    
    PermissionException - if the current User does not have permission to do this.
  - mergeSubmission
```
AssignmentSubmission mergeSubmission(Element el)
                              throws IdInvalidException,
                                     IdUsedException,
                                     PermissionException
```
    Add a new AssignmentSubmission to the directory, from a definition in XML. Must commitEdit() to make official, or cancelEdit() when done!
    
    Parameters:
    
    el - The XML DOM Element defining the submission.
    
    Returns:
    
    A locked AssignmentSubmission object (reserving the id).
    
    Throws:
    
    IdInvalidException - if the submission id is invalid.
    
    IdUsedException - if the submission id is already used.
    
    PermissionException - if the current user does not have permission to add a submission.
  - removeSubmission
```
void removeSubmission(AssignmentSubmission submission)
               throws PermissionException
```
    Removes an AssignmentSubmission and all references to it
    
    Parameters:
    
    submission - - the AssignmentSubmission to remove.
    
    Throws:
    
    PermissionException - if current User does not have permission to do this.
  - updateAssignment
```
void updateAssignment(Assignment assignment)
               throws PermissionException
```
    Parameters:
    
    assignment -
    
    Throws:
    
    PermissionException
  - updateSubmission
```
void updateSubmission(AssignmentSubmission submission)
               throws PermissionException
```
    Parameters:
    
    submission -
    
    Throws:
    
    PermissionException
  - getAssignment
```
Assignment getAssignment(Reference reference)
                  throws IdUnusedException,
                         PermissionException
```
    Parameters:
    
    reference -
    
    Returns:
    
    Throws:
    
    IdUnusedException
    
    PermissionException
  - getAssignment
```
Assignment getAssignment(String assignmentId)
                  throws IdUnusedException,
                         PermissionException
```
    Access the Assignment with the specified id.
    
    Parameters:
    
    assignmentId - - The id of the Assignment.
    
    Returns:
    
    The Assignment corresponding to the id, or null if it does not exist.
    
    Throws:
    
    IdUnusedException - if there is no object with this id.
    
    PermissionException - if the current user is not allowed to read this.
  - getAssignmentCannonicalStatus
```
AssignmentConstants.Status getAssignmentCannonicalStatus(String assignmentId)
                                                  throws IdUnusedException,
                                                         PermissionException
```
    Retrieves the current status of the specified assignment.
    
    Returns:
    
    Throws:
    
    IdUnusedException
    
    PermissionException
  - getSubmission
```
AssignmentSubmission getSubmission(String submissionId)
                            throws IdUnusedException,
                                   PermissionException
```
    Access the AssignmentSubmission with the specified id.
    
    Parameters:
    
    submissionId - - The id of the AssignmentSubmission.
    
    Returns:
    
    The AssignmentSubmission corresponding to the id, or null if it does not exist.
    
    Throws:
    
    IdUnusedException - if there is no object with this id.
    
    PermissionException - if the current user is not allowed to read this.
  - getAssignmentsForContext
```
Collection<Assignment> getAssignmentsForContext(String context)
```
    Access all the Assignemnts that are not deleted and self-drafted ones
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    List All the Assignments will be listed
  - getDeletedAssignmentsForContext
```
Collection<Assignment> getDeletedAssignmentsForContext(String context)
```
    Access all the Assignments that are deleted
    
    Parameters:
    
    context - - Describes the portlet context - generated with DefaultId.getChannel().
    
    Returns:
    
    List All the deleted assignments will be listed
  - getSubmittableAssignmentsForContext
```
Map<Assignment,List<String>> getSubmittableAssignmentsForContext(String context)
```
    Retrieve a map of Assignments to a list of User IDs of those who may submit each assignment. This map is filtered to only those assignments that can be viewed by the current user.
    
    Parameters:
    
    context - the Site ID to search
    
    Returns:
    
    All submittable Assignments in the site mapped to the User IDs of those who can submit them.
  - getSubmission
```
AssignmentSubmission getSubmission(String assignmentId,
                                   User person)
                            throws PermissionException
```
    Access a User's AssignmentSubmission to a particular Assignment.
    
    Parameters:
    
    assignmentId - - The id of the assignment.
    
    person - - The User who's Submission you would like.
    
    Returns:
    
    AssignmentSubmission The user's submission for that Assignment, or null if one does not exist.
    
    Throws:
    
    PermissionException
  - getSubmission
```
AssignmentSubmission getSubmission(String assignmentReference,
                                   String submitterId)
                            throws PermissionException
```
    Access a User or Group's AssignmentSubmission to a particular Assignment.
    
    Parameters:
    
    assignmentReference - - The id of the assignment.
    
    submitterId - - The string id of the person or group who's Submission you would like.
    
    Returns:
    
    AssignmentSubmission The user's submission for that Assignment, or null if one does not exist.
    
    Throws:
    
    PermissionException
  - getSubmission
```
@Deprecated
AssignmentSubmission getSubmission(List<AssignmentSubmission> submissions,
                                               User person)
```
    Deprecated.
    
    Access a User's AssignmentSubmission inside a list of AssignmentSubmission object.
    
    Parameters:
    
    - - submissions The list of submissions
    
    person - - The User who's Submission you would like.
    
    Returns:
    
    AssignmentSubmission The user's submission for that Assignment, or null if one does not exist.
  - getSubmissions
```
Set<AssignmentSubmission> getSubmissions(Assignment assignment)
```
    Get the submissions for an assignment.
    
    Parameters:
    
    assignment - - the Assignment who's submissions you would like.
    
    Returns:
    
    List over all the submissions for an Assignment.
  - getAssignmentStatus
```
String getAssignmentStatus(String assignmentId)
```
    Parameters:
    
    assignmentId -
    
    Returns:
  - getSubmissionStatus
```
String getSubmissionStatus(String submissionId)
```
    Parameters:
    
    submissionId -
    
    Returns:
  - getSortedGroupUsers
```
List<User> getSortedGroupUsers(Group g)
```
    Return a sorted list of users representing a group.
  - countSubmissions
```
int countSubmissions(String assignmentRef,
                     Boolean graded)
```
    Count the number of submissions for a given assignment.
    
    Parameters:
    
    assignmentRef - the assignment reference of the submissions to count.
    
    graded - count the number of submissions which have been submitted and are graded respectively graded is true and ungraded is false or null for both.
    
    Returns:
    
    int count of submissions for the specified assignment.
  - getGradesSpreadsheet
```
byte[] getGradesSpreadsheet(String ref)
                     throws IdUnusedException,
                            PermissionException
```
    Access the grades spreadsheet for the reference, either for an assignment or all assignments in a context.
    
    Parameters:
    
    ref - The reference, either to a specific assignment, or just to an assignment context.
    
    Returns:
    
    The grades spreadsheet bytes.
    
    Throws:
    
    IdUnusedException - if there is no object with this id.
    
    PermissionException - if the current user is not allowed to access this.
  - getSubmissionsZip
```
void getSubmissionsZip(OutputStream out,
                       String ref,
                       String queryString)
                throws IdUnusedException,
                       PermissionException
```
    Access the submissions zip for the assignment reference.
    
    Parameters:
    
    ref - The assignment reference.
    
    out - The outputStream to stream the zip file into
    
    Throws:
    
    IdUnusedException - if there is no object with this id.
    
    PermissionException - if the current user is not allowed to access this.
  - assignmentReference
```
String assignmentReference(String context,
                           String id)
```
    Access the internal reference which can be used to assess security clearance.
    
    Parameters:
    
    id - The assignment id string.
    
    Returns:
    
    The the internal reference which can be used to access the resource from within the system.
  - assignmentReference
```
String assignmentReference(String id)
```
    Access the internal reference which can be used to assess security clearance. This will make a database call, so might not be the best choice in every situation. But, if you don't have the context (site id) and need the reference, it's the only way to get it.
    
    Parameters:
    
    id - The assignment id string.
    
    Returns:
    
    The the internal reference which can be used to access the resource from within the system.
  - submissionReference
```
String submissionReference(String context,
                           String id,
                           String assignmentId)
```
    Access the internal reference which can be used to access the resource from within the system.
    
    Parameters:
    
    id - The submission id string.
    
    Returns:
    
    The the internal reference which can be used to access the resource from within the system.
  - canSubmit
```
boolean canSubmit(Assignment assignment,
                  String userId)
```
    Whether a specific user can submit to this assignment thereby creating a submission
    Of particular importance is whether userId is blank or not, a blank userId will perform all security checks against the current user while a non blank userId will perform all security checks against the specified user.
    
    Parameters:
    
    assignment - the Assignment to check for allowing to submit to
    
    userId - the specified user is checked vs the current user
    
    Returns:
    
    true if the specified user or the current user can submit to the assignment, otherwise false
  - canSubmit
```
boolean canSubmit(Assignment assignment)
```
    Whether the current user can submit to this assignment thereby creating a submission
    
    Parameters:
    
    assignment - the Assignment to check for allowing to submit to
    
    Returns:
    
    true if the current user can submit to the assignment, otherwise false
  - getSubmitterGroupList
```
Collection<Group> getSubmitterGroupList(String searchFilterOnly,
                                        String allOrOneGroup,
                                        String searchString,
                                        String aRef,
                                        String contextString)
```
    Parameters:
    
    searchFilterOnly -
    
    allOrOneGroup -
    
    searchString -
    
    aRef -
    
    contextString -
    
    Returns:
  - getAllowSubmitByInstructor
```
boolean getAllowSubmitByInstructor()
```
    Allow that the instructor can submit an assignment on behalf of student
  - getSubmitterIdList
```
List<String> getSubmitterIdList(String searchFilterOnly,
                                String allOrOneGroup,
                                String search,
                                String aRef,
                                String contextString)
```
    get appropriate submitter id list with group choice and site id
    
    Parameters:
    
    searchFilterOnly - If true, return only those ids that matches the group filter and search criteria
    
    allOrOneGroup - "all" or specific group reference
    
    aRef - Assignment Reference
    
    search - The search string
    
    contextString - Site id
    
    Returns:
  - getSubmitterMap
```
Map<User,AssignmentSubmission> getSubmitterMap(String searchFilterOnly,
                                               String allOrOneGroup,
                                               String search,
                                               String aRef,
                                               String contextString)
```
    Alternative to getSubmittedIdList which returns full user and submissions, since submitterIdList retrieves them anyway
    
    Parameters:
    
    searchFilterOnly - If true, return only those ids that matches the group filter and search criteria
    
    allOrOneGroup - "all" or specific group reference
    
    aRef - Assignment Reference
    
    search - The search string
    
    contextString - Site id
    
    Returns:
  - escapeInvalidCharsEntry
```
String escapeInvalidCharsEntry(String accentedString)
```
    Parameters:
    
    accentedString -
    
    Returns:
  - assignmentUsesAnonymousGrading
```
boolean assignmentUsesAnonymousGrading(Assignment a)
```
    If the assignment uses anonymous grading returns true, else false Params: AssignmentSubmission s
  - getScaleFactor
```
Integer getScaleFactor()
```
    Get Scale Factor from the property assignment.grading.decimals
    
    Returns:
  - getDeepLinkWithPermissions
```
String getDeepLinkWithPermissions(String context,
                                  String assignmentId,
                                  boolean allowReadAssignment,
                                  boolean allowAddAssignment,
                                  boolean allowSubmitAssignment)
                           throws Exception
```
    Get a link directly into an assignment itself, supplying the permissions to use when generating the link. Depending on your status, you get a different view on the assignment.
    
    Parameters:
    
    context - The site id
    
    assignmentId - The assignment id
    
    allowReadAssignment - Is the curent user allowed to read?
    
    allowAddAssignment - Is the curent user allowed to add assignments?
    
    allowSubmitAssignment - Is the curent user allowed to submit assignments?
    
    Returns:
    
    The url as a String
    
    Throws:
    
    Exception
  - getDeepLink
```
String getDeepLink(String context,
                   String assignmentId,
                   String userId)
            throws Exception
```
    Get a link directly into an assignment itself. Depending on your status, you get a different view on the assignment.
    
    Parameters:
    
    context - The site id
    
    assignmentId - The assignment id
    
    userId - The user id
    
    Returns:
    
    The url as a String
    
    Throws:
    
    Exception
  - getCsvSeparator
```
String getCsvSeparator()
```
    get csv separator for exporting to CSV. It can be a comma or point configured through csv.separator sakai property
    
    Returns:
  - getXmlAssignment
```
String getXmlAssignment(Assignment assignment)
```
    Parameters:
    
    assignment -
    
    Returns:
  - getGradeForSubmitter
```
String getGradeForSubmitter(String submissionId,
                            String submitter)
```
  - getGradeForSubmitter
```
String getGradeForSubmitter(AssignmentSubmission submission,
                            String submitter)
```
  - getGradeDisplay
```
String getGradeDisplay(String grade,
                       Assignment.GradeType typeOfGrade,
                       Integer scaleFactor)
```
    Parameters:
    
    grade -
    
    typeOfGrade -
    
    scaleFactor -
    
    Returns:
  - getMaxPointGradeDisplay
```
String getMaxPointGradeDisplay(int factor,
                               int maxGradePoint)
```
    Parameters:
    
    factor -
    
    maxGradePoint -
    
    Returns:
  - getSubmissionSubmittee
```
Optional<AssignmentSubmissionSubmitter> getSubmissionSubmittee(AssignmentSubmission submission)
```
    Parameters:
    
    submission -
    
    Returns:
  - getSubmissionSubmittersAsUsers
```
Collection<User> getSubmissionSubmittersAsUsers(AssignmentSubmission submission)
```
    Parameters:
    
    submission -
    
    Returns:
  - isPeerAssessmentOpen
```
boolean isPeerAssessmentOpen(Assignment assignment)
```
    peer assessment is set for this assignment and the current time falls between the assignment close time and the peer asseessment period time
    
    Returns:
  - isPeerAssessmentPending
```
boolean isPeerAssessmentPending(Assignment assignment)
```
    peer assessment is set for this assignment but the close time hasn't passed
    
    Returns:
  - isPeerAssessmentClosed
```
boolean isPeerAssessmentClosed(Assignment assignment)
```
    peer assessment is set for this assignment but the current time is passed the peer assessment period
    
    Returns:
  - resetAssignment
```
void resetAssignment(Assignment assignment)
```
    Parameters:
    
    assignment -
  - postReviewableSubmissionAttachments
```
void postReviewableSubmissionAttachments(AssignmentSubmission submission)
```
    Parameters:
    
    submissionId -
  - getToolTitle
```
String getToolTitle()
```
    This will return the internationalized title of the tool. This is used when creating a new gradebook item.
  - getUsersLocalDateTimeString
```
String getUsersLocalDateTimeString(Instant date)
```
  - getContentReviewResults
```
List<ContentReviewResult> getContentReviewResults(AssignmentSubmission submission)
```
  - isContentReviewVisibleForSubmission
```
boolean isContentReviewVisibleForSubmission(AssignmentSubmission submission)
```
    Determines whether it is appropriate to display the content review results for a submission. For instance, this will be false if the submission is a draft or if the user doesn't have permission Note: this doesn't check if content review is enabled in the site / if the associated assignment has content review enabled; it is assumed that this has been handled by the caller.
    
    Parameters:
    
    submission -
    
    Returns:
    
    true if content review results for the given submission can be displayed.

Interface AssignmentService

Method Summary

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer

Method Detail

createAssignmentEntity

createAssignmentEntity

allowReceiveSubmissionNotification

allowReceiveSubmissionNotificationUsers

getGroupsAllowRemoveAssignment

allowAddAssignment

allowUpdateAssignmentInContext

allowAddSiteAssignment

allowRemoveAssignmentInContext

allowAllGroups

allowGetAssignment

getGroupsAllowAddAssignment

getGroupsAllowUpdateAssignment

getGroupsAllowGradeAssignment

allowUpdateAssignment

allowRemoveAssignment

allowAddSubmission

allowAddSubmissionCheckGroups

allowAddSubmissionUsers

allowGradeAssignmentUsers

allowAddAnySubmissionUsers

allowAddAssignmentUsers

allowGetSubmission

allowUpdateSubmission

allowRemoveSubmission

allowReviewService

allowGradeSubmission

addAssignment

mergeAssignment

addDuplicateAssignment

deleteAssignment

softDeleteAssignment

deleteAssignmentAndAllReferences

addSubmission

mergeSubmission

removeSubmission

updateAssignment

updateSubmission

getAssignment

getAssignment

getAssignmentCannonicalStatus

getSubmission

getAssignmentsForContext

getDeletedAssignmentsForContext

getSubmittableAssignmentsForContext

getSubmission

getSubmission

getSubmission

getSubmissions

getAssignmentStatus

getSubmissionStatus

getSortedGroupUsers

countSubmissions

getGradesSpreadsheet

getSubmissionsZip

assignmentReference

assignmentReference

submissionReference

canSubmit

canSubmit

getSubmitterGroupList

getAllowSubmitByInstructor

getSubmitterIdList

getSubmitterMap

escapeInvalidCharsEntry

assignmentUsesAnonymousGrading

getScaleFactor

getDeepLinkWithPermissions

getDeepLink

getCsvSeparator

getXmlAssignment

getGradeForSubmitter

getGradeForSubmitter

getGradeDisplay

getMaxPointGradeDisplay

getSubmissionSubmittee