org.sakaiproject.tool.gradebook

Class Assignment

java.lang.Object

org.sakaiproject.tool.gradebook.GradableObject

org.sakaiproject.tool.gradebook.Assignment

All Implemented Interfaces:

Serializable

public class Assignment
extends GradableObject

An Assignment is the basic unit that composes a gradebook. It represents a single unit that, when aggregated in a gradebook, can be used as the denomenator in calculating a CourseGradeRecord.

Author:

Josh Holtzman

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator	categoryComparator
static Comparator	countedComparator
static Comparator	dateComparator
static String	DEFAULT_SORT Deprecated.
static Comparator	gradeEditorComparator
static String	item_type_adjustment
static String	item_type_letter
static String	item_type_nonCalc
static String	item_type_percentage
static String	item_type_points
static Comparator	meanComparator
static Comparator	nameComparator
static Comparator	pointsComparator
static Comparator	releasedComparator
String	selectedGradeEntryValue
static String	SORT_BY_COUNTED Deprecated.
static String	SORT_BY_DATE Deprecated.
static String	SORT_BY_EDITOR Deprecated.
static String	SORT_BY_MEAN Deprecated.
static String	SORT_BY_NAME Deprecated.
static String	SORT_BY_POINTS Deprecated.
static String	SORT_BY_RELEASED Deprecated.
static String	SORT_BY_SORTING Deprecated.

Fields inherited from class org.sakaiproject.tool.gradebook.GradableObject

categorizedSortOrder, defaultComparator, gradebook, id, idComparator, mean, name, removed, sortingComparator, sortOrder, version

Constructor Summary

Constructors

Constructor and Description
Assignment()
Assignment(Gradebook gradebook, String name, Double pointsPossible, Date dueDate)
Assignment(Gradebook gradebook, String name, Double pointsPossible, Date dueDate, boolean released) constructor to support selective release

Method Summary

Modifier and Type	Method and Description
void	calculateStatistics(Collection<AssignmentGradeRecord> gradeRecords) Calculate the mean score for students with entered grades.
Double	getAssignmentWeighting()
Double	getAverageTotal()
Category	getCategory()
Boolean	getCountNullsAsZeros()
Date	getDateForDisplay()
Date	getDueDate()
String	getExternalAppName()
String	getExternalId()
String	getExternalInstructorLink()
String	getExternalStudentLink()
boolean	getIsCategory()
Boolean	getIsExtraCredit()
String	getItemType()
Double	getPointsPossible()
String	getSelectedGradeEntryValue()
boolean	getUngraded()
boolean	isAssignment()
boolean	isCounted()
boolean	isCourseGrade()
boolean	isExternallyMaintained()
Boolean	isExtraCredit()
boolean	isHideInAllGradesTable()
boolean	isIncludedInCalculations() Convenience method for checking if the grade for the assignment should be included in calculations.
boolean	isNotCounted()
boolean	isReleased()
void	setAssignmentWeighting(Double assignmentWeighting)
void	setAverageTotal(Double averageTotal)
void	setCategory(Category category)
void	setCounted(boolean counted) This cover is for the benefit of JSF checkboxes.
void	setCountNullsAsZeros(Boolean countNullsAsZeros)
void	setDueDate(Date dueDate)
void	setExternalAppName(String externalAppName)
void	setExternalId(String externalId)
void	setExternalInstructorLink(String externalInstructorLink)
void	setExternallyMaintained(boolean externallyMaintained)
void	setExternalStudentLink(String externalStudentLink)
void	setExtraCredit(Boolean isExtraCredit)
void	setHideInAllGradesTable(boolean hideInAllGradesTable)
void	setIsExtraCredit(Boolean isExtraCredit)
void	setItemType(String itemType)
void	setNotCounted(boolean notCounted)
void	setPointsPossible(Double pointsPossible)
void	setReleased(boolean released)
void	setSelectedGradeEntryValue(String selectedGradeEntryValue)
void	setUngraded(boolean ungraded)

Methods inherited from class org.sakaiproject.tool.gradebook.GradableObject

assignSorting, equals, getCategorizedSortOrder, getFormattedMean, getGradebook, getId, getMean, getName, getSortOrder, getSortPosition, getVersion, hashCode, isFirst, isLast, isRemoved, setCategorizedSortOrder, setGradebook, setId, setMean, setName, setRemoved, setSortOrder, setVersion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SORT_BY_DATE

@Deprecated
public static String SORT_BY_DATE

Deprecated.

use the SortType enum instead. This remains only for the gradebook tool

SORT_BY_NAME

@Deprecated
public static String SORT_BY_NAME

Deprecated.

SORT_BY_MEAN

@Deprecated
public static String SORT_BY_MEAN

Deprecated.

SORT_BY_POINTS

@Deprecated
public static String SORT_BY_POINTS

Deprecated.

SORT_BY_RELEASED

@Deprecated
public static String SORT_BY_RELEASED

Deprecated.

SORT_BY_COUNTED

@Deprecated
public static String SORT_BY_COUNTED

Deprecated.

SORT_BY_EDITOR

@Deprecated
public static String SORT_BY_EDITOR

Deprecated.

SORT_BY_SORTING

@Deprecated
public static String SORT_BY_SORTING

Deprecated.

DEFAULT_SORT

@Deprecated
public static String DEFAULT_SORT

Deprecated.

item_type_points

public static String item_type_points

item_type_percentage

public static String item_type_percentage

item_type_letter

public static String item_type_letter

item_type_nonCalc

public static String item_type_nonCalc

item_type_adjustment

public static String item_type_adjustment

dateComparator

public static Comparator dateComparator

nameComparator

public static Comparator nameComparator

pointsComparator

public static Comparator pointsComparator

meanComparator

public static Comparator meanComparator

releasedComparator

public static Comparator releasedComparator

countedComparator

public static Comparator countedComparator

gradeEditorComparator

public static Comparator gradeEditorComparator

categoryComparator

public static Comparator categoryComparator

selectedGradeEntryValue

public String selectedGradeEntryValue

Constructor Detail

Assignment

public Assignment()

Assignment

public Assignment(Gradebook gradebook,
                  String name,
                  Double pointsPossible,
                  Date dueDate)

Assignment

public Assignment(Gradebook gradebook,
                  String name,
                  Double pointsPossible,
                  Date dueDate,
                  boolean released)

constructor to support selective release

Parameters:

gradebook -

name -

pointsPossible -

dueDate -

released -

Method Detail

isCourseGrade

public boolean isCourseGrade()

Specified by:

isCourseGrade in class GradableObject

Returns:

Whether this gradable object is a course grade

isAssignment

public boolean isAssignment()

Specified by:

isAssignment in class GradableObject

Returns:

Whether this gradable object is an assignment

See Also:

GradableObject.isAssignment()

getIsCategory

public boolean getIsCategory()

Specified by:

getIsCategory in class GradableObject

Returns:

Whether this gradable object is a category

See Also:

GradableObject.getIsCategory()

getDateForDisplay

public Date getDateForDisplay()

getDueDate

public Date getDueDate()

Returns:

Returns the dueDate.

setDueDate

public void setDueDate(Date dueDate)

Parameters:

dueDate - The dueDate to set.

isNotCounted

public boolean isNotCounted()

setNotCounted

public void setNotCounted(boolean notCounted)

isCounted

public boolean isCounted()

setCounted

public void setCounted(boolean counted)

This cover is for the benefit of JSF checkboxes.

getExternalInstructorLink

public String getExternalInstructorLink()

Returns:

Returns the externalInstructorLink.

setExternalInstructorLink

public void setExternalInstructorLink(String externalInstructorLink)

Parameters:

externalInstructorLink - The externalInstructorLink to set.

isExternallyMaintained

public boolean isExternallyMaintained()

Returns:

Returns the externallyMaintained.

setExternallyMaintained

public void setExternallyMaintained(boolean externallyMaintained)

Parameters:

externallyMaintained - The externallyMaintained to set.

getExternalStudentLink

public String getExternalStudentLink()

Returns:

Returns the externalStudentLink.

setExternalStudentLink

public void setExternalStudentLink(String externalStudentLink)

Parameters:

externalStudentLink - The externalStudentLink to set.

getPointsPossible

public Double getPointsPossible()

Returns:

Returns the pointsPossible.

setPointsPossible

public void setPointsPossible(Double pointsPossible)

Parameters:

pointsPossible - The pointsPossible to set.

getExternalId

public String getExternalId()

Returns:

Returns the externalId.

setExternalId

public void setExternalId(String externalId)

Parameters:

externalId - The externalId to set.

getExternalAppName

public String getExternalAppName()

Returns:

Returns the externalAppName.

setExternalAppName

public void setExternalAppName(String externalAppName)

Parameters:

externalAppName - The externalAppName to set.

isReleased

public boolean isReleased()

Returns:

selective release true or false

setReleased

public void setReleased(boolean released)

Parameters:

released - returns wther the assignment has been released to users

calculateStatistics

public void calculateStatistics(Collection<AssignmentGradeRecord> gradeRecords)

Calculate the mean score for students with entered grades.

getCategory

public Category getCategory()

setCategory

public void setCategory(Category category)

getAverageTotal

public Double getAverageTotal()

setAverageTotal

public void setAverageTotal(Double averageTotal)

getUngraded

public boolean getUngraded()

setUngraded

public void setUngraded(boolean ungraded)

getIsExtraCredit

public Boolean getIsExtraCredit()

setIsExtraCredit

public void setIsExtraCredit(Boolean isExtraCredit)

isExtraCredit

public Boolean isExtraCredit()

setExtraCredit

public void setExtraCredit(Boolean isExtraCredit)

getAssignmentWeighting

public Double getAssignmentWeighting()

setAssignmentWeighting

public void setAssignmentWeighting(Double assignmentWeighting)

getItemType

public String getItemType()

setItemType

public void setItemType(String itemType)

getCountNullsAsZeros

public Boolean getCountNullsAsZeros()

setCountNullsAsZeros

public void setCountNullsAsZeros(Boolean countNullsAsZeros)

getSelectedGradeEntryValue

public String getSelectedGradeEntryValue()

setSelectedGradeEntryValue

public void setSelectedGradeEntryValue(String selectedGradeEntryValue)

isIncludedInCalculations

public boolean isIncludedInCalculations()

Convenience method for checking if the grade for the assignment should be included in calculations. This is different from just the isCounted() method for an assignment. This method does a more thorough check using other values, such as if removed, isExtraCredit, ungraded, etc in addition to the assignment's notCounted property. Now also considers category type. If categories are configured (setting 2 or 3), uncategorised items are not counted.

Returns:

true if grades for this assignment should be included in various calculations.

isHideInAllGradesTable

public boolean isHideInAllGradesTable()

setHideInAllGradesTable

public void setHideInAllGradesTable(boolean hideInAllGradesTable)