org.sakaiproject.service.legacy.assignment
Interface AssignmentSubmissionEdit

All Superinterfaces:
AssignmentSubmission, Edit, Entity
All Known Implementing Classes:
BaseAssignmentService.BaseAssignmentSubmissionEdit

public interface AssignmentSubmissionEdit
extends AssignmentSubmission, Edit

AssignmentSubmissionEdit is an interface for the CHEF assignments module. It represents editable student submissions for assignments.

Version:
$ $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 void addFeedbackAttachment(Reference attachment)
          Add an attachment to the list of feedback attachments.
 void addSubmittedAttachment(Reference attachment)
          Add an attachment to the list of submitted attachments.
 void addSubmitter(User submitter)
          Add a User to the submitters list.
 void clearFeedbackAttachments()
          Remove all feedback attachments.
 void clearSubmittedAttachments()
          Remove all submitted attachments.
 void clearSubmitters()
          Remove all user from the submitter list
 void removeFeedbackAttachment(Reference attachment)
          Remove an attachment from the list of feedback attachments.
 void removeSubmittedAttachment(Reference attachment)
          Remove an attachment from the list of submitted attachments
 void removeSubmitter(User submitter)
          Remove an User from the submitter list
 void setAssignment(Assignment assignment)
          Set the Assignment for this Submission
 void setContext(String context)
          Set the AssignmentSubmissions's context at the time of creation.
 void setFeedbackComment(String comment)
          Set the general comments by the grader.
 void setFeedbackText(String feedback)
          Set the text part of the instructors feedback; usually an annotated copy of the submittedText
 void setGrade(String grade)
          Sets the grade for the Submisssion.
 void setGraded(boolean graded)
          Set whether this Submission has been graded.
 void setGradeReleased(boolean released)
          Set whether the grade has been released.
 void setHonorPledgeFlag(boolean honorPledgeFlag)
          Set the checked status of the honor pledge flag.
 void setReturned(boolean returned)
          Set whether this Submission was rejected by the grader.
 void setSubmitted(boolean submitted)
          Set whether this is a final submission.
 void setSubmittedText(String submissionText)
          Text submitted in response to the Assignment.
 void setTimeLastModified(Time lastmod)
          Set the time last modified.
 void setTimeReturned(Time timeReturned)
          Set the time at which the graded Submission was returned; setting it to null means it is not yet graded.
 void setTimeSubmitted(Time timeSubmitted)
          Set the time at which this response was submitted; setting it to null signifies the response is unsubmitted.
 
Methods inherited from interface org.sakaiproject.service.legacy.assignment.AssignmentSubmission
getAssignment, getAssignmentId, getContext, getFeedbackAttachments, getFeedbackComment, getFeedbackText, getGrade, getGraded, getGradeDisplay, getGradeReleased, getHonorPledgeFlag, getReturned, getStatus, getSubmitted, getSubmittedAttachments, getSubmittedText, getSubmitterIds, getSubmitters, getTimeLastModified, getTimeReturned, getTimeSubmitted
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 

Method Detail

setContext

public void setContext(String context)
Set the AssignmentSubmissions's context at the time of creation.

Parameters:
context - - The context string.

setAssignment

public void setAssignment(Assignment assignment)
Set the Assignment for this Submission

Parameters:
assignment - - the Assignment

addSubmitter

public void addSubmitter(User submitter)
Add a User to the submitters list.

Parameters:
submitter - - the User to add.

removeSubmitter

public void removeSubmitter(User submitter)
Remove an User from the submitter list

Parameters:
submitter - - the User to remove.

clearSubmitters

public void clearSubmitters()
Remove all user from the submitter list


setSubmitted

public void setSubmitted(boolean submitted)
Set whether this is a final submission.

Parameters:
submitted - - True if a final submission, false if still a draft.

setTimeSubmitted

public void setTimeSubmitted(Time timeSubmitted)
Set the time at which this response was submitted; setting it to null signifies the response is unsubmitted.

Parameters:
timeSubmitted - - Time of submission.

setSubmittedText

public void setSubmittedText(String submissionText)
Text submitted in response to the Assignment.

Parameters:
submissionText - - The text of the submission.

addSubmittedAttachment

public void addSubmittedAttachment(Reference attachment)
Add an attachment to the list of submitted attachments.

Parameters:
attachment - - The Reference object pointing to the attachment.

removeSubmittedAttachment

public void removeSubmittedAttachment(Reference attachment)
Remove an attachment from the list of submitted attachments

Parameters:
attachment - - The Reference object pointing to the attachment.

clearSubmittedAttachments

public void clearSubmittedAttachments()
Remove all submitted attachments.


setFeedbackComment

public void setFeedbackComment(String comment)
Set the general comments by the grader.

Parameters:
comment - - the text of the grader's comments; may be null.

setFeedbackText

public void setFeedbackText(String feedback)
Set the text part of the instructors feedback; usually an annotated copy of the submittedText

Parameters:
feedback - - The text of the grader's feedback.

addFeedbackAttachment

public void addFeedbackAttachment(Reference attachment)
Add an attachment to the list of feedback attachments.

Parameters:
attachment - - The Resource object pointing to the attachment.

removeFeedbackAttachment

public void removeFeedbackAttachment(Reference attachment)
Remove an attachment from the list of feedback attachments.

Parameters:
attachment - - The Resource pointing to the attachment to remove.

clearFeedbackAttachments

public void clearFeedbackAttachments()
Remove all feedback attachments.


setReturned

public void setReturned(boolean returned)
Set whether this Submission was rejected by the grader.

Parameters:
returned - - true if this response was rejected by the grader, false otherwise.

setGraded

public void setGraded(boolean graded)
Set whether this Submission has been graded.

Parameters:
graded - - true if the submission has been graded, false otherwise.

setGradeReleased

public void setGradeReleased(boolean released)
Set whether the grade has been released.

Parameters:
released - - True if the Submissions's grade has been released, false otherwise.

setGrade

public void setGrade(String grade)
Sets the grade for the Submisssion.

Parameters:
grade - - The Submission's grade.

setTimeReturned

public void setTimeReturned(Time timeReturned)
Set the time at which the graded Submission was returned; setting it to null means it is not yet graded.

Parameters:
timeReturned - - The time at which the graded Submission was returned.

setHonorPledgeFlag

public void setHonorPledgeFlag(boolean honorPledgeFlag)
Set the checked status of the honor pledge flag.

Parameters:
honorPledgeFlag - - True if the honor pledge is checked, false otherwise.

setTimeLastModified

public void setTimeLastModified(Time lastmod)
Set the time last modified.

Parameters:
lastmod - - The Time at which the Submission was last modified.