org.sakaiproject.service.legacy.assignment
Interface AssignmentContent

All Superinterfaces:
AttachmentContainer, Entity
All Known Subinterfaces:
AssignmentContentEdit
All Known Implementing Classes:
BaseAssignmentService.BaseAssignmentContent, BaseAssignmentService.BaseAssignmentContentEdit

public interface AssignmentContent
extends Entity, AttachmentContainer

AssignmentContent is the an interface for the CHEF assignments module. It represents the part of the assignment content that is "unchanging" for different versions of the assignment.

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

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 boolean getAllowAttachments()
          Access whether this AssignmentContent allows attachments.
 String getAuthorLastModified()
          Access the author of last modificaiton
 List getAuthors()
          Access the list of authors.
 String getContext()
          Access the context at the time of creation.
 String getCreator()
          Access the creator of this object.
 boolean getGroupProject()
          Get whether this project can be a group project.
 int getHonorPledge()
          Access the Honor Pledge type; values are NONE and ENGINEERING_HONOR_PLEDGE.
 String getInstructions()
          Access the instructions for the assignment
 int getMaxGradePoint()
          Gets the maximum grade if grade type is SCORE_GRADE_TYPE(3)
 String getMaxGradePointDisplay()
          Get the maximum grade for grade type = SCORE_GRADE_TYPE(3) Formated to show one decimal place
 Time getTimeCreated()
          Access the time that this object was created.
 Time getTimeLastModified()
          Access the time of last modificaiton.
 String getTitle()
          Access the title.
 int getTypeOfGrade()
          Access the grade type
 String getTypeOfGradeString(int gradeType)
          Access a string describing the type of grade.
 int getTypeOfSubmission()
          Access the type of submission.
 boolean individuallyGraded()
          Access whether group projects should be individually graded.
 boolean inUse()
          Access whether this AssignmentContent is in use by an Assignment.
 boolean releaseGrades()
          Access whether grades can be released once submissions are graded.
 
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.AttachmentContainer
getAttachments
 

Method Detail

getCreator

public String getCreator()
Access the creator of this object.

Returns:
String - the user id of the creator.

getTitle

public String getTitle()
Access the title.

Returns:
The AssignmentContent's title.

getContext

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

Returns:
String - the context string.

getInstructions

public String getInstructions()
Access the instructions for the assignment

Returns:
The Assignment's instructions.

getTimeCreated

public Time getTimeCreated()
Access the time that this object was created.

Returns:
The Time object representing the time of creation.

getTimeLastModified

public Time getTimeLastModified()
Access the time of last modificaiton.

Returns:
The Time of last modification.

getAuthorLastModified

public String getAuthorLastModified()
Access the author of last modificaiton

Returns:
the User

getTypeOfSubmission

public int getTypeOfSubmission()
Access the type of submission.

Returns:
An integer representing the type of submission.

getTypeOfGrade

public int getTypeOfGrade()
Access the grade type

Returns:
The integer representing the type of grade.

getTypeOfGradeString

public String getTypeOfGradeString(int gradeType)
Access a string describing the type of grade.

Parameters:
gradeType - - The integer representing the type of grade.
Returns:
Description of the type of grade.

getMaxGradePoint

public int getMaxGradePoint()
Gets the maximum grade if grade type is SCORE_GRADE_TYPE(3)

Returns:
int The maximum grade score, or zero if the grade type is not SCORE_GRADE_TYPE(3).

getMaxGradePointDisplay

public String getMaxGradePointDisplay()
Get the maximum grade for grade type = SCORE_GRADE_TYPE(3) Formated to show one decimal place

Returns:
The maximum grade score.

getGroupProject

public boolean getGroupProject()
Get whether this project can be a group project.

Returns:
True if this can be a group project, false otherwise.

individuallyGraded

public boolean individuallyGraded()
Access whether group projects should be individually graded.

Returns:
true if projects are individually graded, false if grades are given to the group.

releaseGrades

public boolean releaseGrades()
Access whether grades can be released once submissions are graded.

Returns:
True if grades can be released once submission are graded, false if they must be released manually.

getHonorPledge

public int getHonorPledge()
Access the Honor Pledge type; values are NONE and ENGINEERING_HONOR_PLEDGE.

Returns:
The type of pledge.

getAllowAttachments

public boolean getAllowAttachments()
Access whether this AssignmentContent allows attachments.

Returns:
true if the AssignmentContent allows attachments, false otherwise.

getAuthors

public List getAuthors()
Access the list of authors.

Returns:
List of the author's user-ids.

inUse

public boolean inUse()
Access whether this AssignmentContent is in use by an Assignment.

Returns:
boolean - Is this AssignmentContent used by an Assignment.