org.sakaiproject.service.legacy.assignment
Interface AssignmentSubmission

All Superinterfaces:
Entity
All Known Subinterfaces:
AssignmentSubmissionEdit
All Known Implementing Classes:
BaseAssignmentService.BaseAssignmentSubmission, BaseAssignmentService.BaseAssignmentSubmissionEdit

public interface AssignmentSubmission
extends Entity

AssignmentSubmission is the an interface for the CHEF assignments module. It represents 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
 Assignment getAssignment()
          Access the Assignment for this Submission
 String getAssignmentId()
          Access the ID for the Assignment for this Submission
 String getContext()
          Access the context at the time of creation.
 List getFeedbackAttachments()
          Access the list of attachments returned to the students in the process of grading this assignment; usually a modified or annotated version of the attachment submitted.
 String getFeedbackComment()
          Get the general comments by the grader
 String getFeedbackText()
          Access the text part of the instructors feedback; usually an annotated copy of the submittedText
 String getGrade()
          Access the grade recieved.
 boolean getGraded()
          Get whether this Submission has been graded.
 String getGradeDisplay()
          Access the grade recieved.
 boolean getGradeReleased()
          Get whether the grade has been released.
 boolean getHonorPledgeFlag()
          Access the checked status of the honor pledge flag.
 boolean getReturned()
          Get whether this Submission was rejected by the grader.
 String getStatus()
          Returns the status of the submission : Not Started, submitted, returned or graded.
 boolean getSubmitted()
          Get whether this is a final submission.
 List getSubmittedAttachments()
          Access the list of attachments to this response to the Assignment.
 String getSubmittedText()
          Text submitted in response to the Assignment.
 List getSubmitterIds()
          Access the list of Users who submitted this response to the Assignment.
 User[] getSubmitters()
          Access the list of Users who submitted this response to the Assignment.
 Time getTimeLastModified()
          Get the time of last modification;
 Time getTimeReturned()
          Get the time at which the graded submission was returned; null means the response is not yet graded.
 Time getTimeSubmitted()
          Set the time at which this response was submitted; null signifies the response is unsubmitted.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 

Method Detail

getContext

public String getContext()
Access the context at the time of creation.

Returns:
String - the context string.

getAssignment

public Assignment getAssignment()
Access the Assignment for this Submission

Returns:
the Assignment

getAssignmentId

public String getAssignmentId()
Access the ID for the Assignment for this Submission

Returns:
String - the Assignment id

getSubmitters

public User[] getSubmitters()
Access the list of Users who submitted this response to the Assignment.

Returns:
Array of user objects.

getSubmitterIds

public List getSubmitterIds()
Access the list of Users who submitted this response to the Assignment.

Returns:
List of user ids

getSubmitted

public boolean getSubmitted()
Get whether this is a final submission.

Returns:
True if a final submission, false if still a draft.

getTimeSubmitted

public Time getTimeSubmitted()
Set the time at which this response was submitted; null signifies the response is unsubmitted.

Returns:
Time of submission.

getSubmittedText

public String getSubmittedText()
Text submitted in response to the Assignment.

Returns:
The text of the submission.

getSubmittedAttachments

public List getSubmittedAttachments()
Access the list of attachments to this response to the Assignment.

Returns:
List of the list of attachments as Reference objects;

getFeedbackComment

public String getFeedbackComment()
Get the general comments by the grader

Returns:
The text of the grader's comments; may be null.

getFeedbackText

public String getFeedbackText()
Access the text part of the instructors feedback; usually an annotated copy of the submittedText

Returns:
The text of the grader's feedback.

getFeedbackAttachments

public List getFeedbackAttachments()
Access the list of attachments returned to the students in the process of grading this assignment; usually a modified or annotated version of the attachment submitted.

Returns:
List of the Resource objects pointing to the attachments.

getReturned

public boolean getReturned()
Get whether this Submission was rejected by the grader.

Returns:
True if this response was rejected by the grader, false otherwise.

getGraded

public boolean getGraded()
Get whether this Submission has been graded.

Returns:
True if the submission has been graded, false otherwise.

getGradeReleased

public boolean getGradeReleased()
Get whether the grade has been released.

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

getGrade

public String getGrade()
Access the grade recieved.

Returns:
The Submission's grade..

getGradeDisplay

public String getGradeDisplay()
Access the grade recieved. When points-type, format it to one decimal place

Returns:
The Submission's grade..

getTimeLastModified

public Time getTimeLastModified()
Get the time of last modification;

Returns:
The time of last modification.

getTimeReturned

public Time getTimeReturned()
Get the time at which the graded submission was returned; null means the response is not yet graded.

Returns:
the time (may be null)

getHonorPledgeFlag

public boolean getHonorPledgeFlag()
Access the checked status of the honor pledge flag.

Returns:
True if the honor pledge is checked, false otherwise.

getStatus

public String getStatus()
Returns the status of the submission : Not Started, submitted, returned or graded.

Returns:
The Submission's status.