Package org.sakaiproject.tool.gradebook

Class GradebookAssignment

java.lang.Object

org.sakaiproject.tool.gradebook.GradableObject

org.sakaiproject.tool.gradebook.GradebookAssignment

All Implemented Interfaces:

Serializable

public class GradebookAssignment
extends GradableObject

An GradebookAssignment 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	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	Description
GradebookAssignment()
GradebookAssignment(Gradebook gradebook, String name, Double pointsPossible, Date dueDate)
GradebookAssignment(Gradebook gradebook, String name, Double pointsPossible, Date dueDate, boolean released)	constructor to support selective release

Method Summary

Modifier and Type	Method	Description
void	calculateStatistics(Collection<AssignmentGradeRecord> gradeRecords)	Calculate the mean score for students with entered grades.
boolean	getIsCategory()
Boolean	getIsExtraCredit()
String	getItemType()
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	setCounted(boolean counted)	This cover is for the benefit of JSF checkboxes.
void	setIsExtraCredit(Boolean isExtraCredit)

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

GradebookAssignment

public GradebookAssignment()

GradebookAssignment

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

GradebookAssignment

public GradebookAssignment(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()

isNotCounted

public boolean isNotCounted()

isCounted

public boolean isCounted()

setCounted

public void setCounted(boolean counted)

This cover is for the benefit of JSF checkboxes.

isExternallyMaintained

public boolean isExternallyMaintained()

Returns:

Returns the externallyMaintained.

isReleased

public Boolean isReleased()

Returns:

selective release true or false

calculateStatistics

public void calculateStatistics(Collection<AssignmentGradeRecord> gradeRecords)

Calculate the mean score for students with entered grades.

getUngraded

public boolean getUngraded()

getIsExtraCredit

public Boolean getIsExtraCredit()

setIsExtraCredit

public void setIsExtraCredit(Boolean isExtraCredit)

isExtraCredit

public Boolean isExtraCredit()

getItemType

public String getItemType()

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()