blackboard.ws.gradebook
Class AttemptVO

java.lang.Object
  blackboard.ws.gradebook.AttemptVO

public class AttemptVO
extends java.lang.Object

An AttemptVO represents an attempt for a gradable item and has an associated Gradebook grade and an attempt date. The final grade assigned to a course member for a particular gradable item depends on the aggregation model and whether the grade has been overridden by the instructor.
(C) Copyright Blackboard Inc. 2007-2008 - All Rights Reserved

Since:

Bb 9.1

Field Summary

java.lang.String

displayGrade

Constructor Summary

AttemptVO()

Method Summary

long	getAttemptDate() This is a read-only attribute set by the server.
long	getCreationDate() This is a read-only attribute set by the server.
java.lang.String	getDisplayGrade() If status is not set, "-" is returned.
java.lang.String[]	getExpansionData()
java.lang.String	getFeedbackToUser()
java.lang.String	getGrade()
java.lang.String	getGradeId()
java.lang.String	getGroupAttemptId()
java.lang.String	getId()
java.lang.String	getInstructorNotes()
double	getScore()
java.lang.String	getStatus() This is a read-only attribute set by the server.
java.lang.String	getStudentComments()
java.lang.String	getStudentSubmission()
java.lang.String	getStudentSubmissionTextType()
boolean	isExempt()
boolean	isOverride() Means the grade has been changed outside of the attempt container itself (i.e. from within the grade center, not from, for example, within the view attempt page from the assessment or assignment).
boolean	isPublicFeedbackToUser()
void	setAttemptDate(long attemptDate) This is a read-only attribute set by the server.
void	setCreationDate(long creationDate) This is a read-only attribute set by the server.
void	setDisplayGrade(java.lang.String displayGrade) This is a read-only attribute set by the server.
void	setExempt(boolean exempt)
void	setExpansionData(java.lang.String[] expansionData) If you wish to create an attempt in IN PROGRESS status, add the expansion data: setStatusToInProgressAndIgnoreGrade=true
void	setFeedbackToUser(java.lang.String feedbackToUser)
void	setGrade(java.lang.String grade)
void	setGradeId(java.lang.String gradeId)
void	setGroupAttemptId(java.lang.String groupAttemptId)
void	setId(java.lang.String id)
void	setInstructorNotes(java.lang.String instructorNotes)
void	setOverride(boolean override)
void	setPublicFeedbackToUser(boolean publicFeedbackToUser)
void	setScore(double score)
void	setStatus(java.lang.String status) This is a read-only attribute set by the server.
void	setStudentComments(java.lang.String studentComments)
void	setStudentSubmission(java.lang.String studentSubmission)
void	setStudentSubmissionTextType(java.lang.String studentSubmissionTextType) Possible values are: HTML PLAIN_TEXT SMART_TEXT If not specified or an invalid value is specified then SMART_TEXT is assumed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

displayGrade

public java.lang.String displayGrade

Constructor Detail

AttemptVO

public AttemptVO()

Method Detail

getAttemptDate

public long getAttemptDate()

This is a read-only attribute set by the server.

Returns:

attempt date

setAttemptDate

public void setAttemptDate(long attemptDate)

This is a read-only attribute set by the server.

Parameters:

attemptDate - date of the attempt

getCreationDate

public long getCreationDate()

This is a read-only attribute set by the server.

Returns:

date of creation

setCreationDate

public void setCreationDate(long creationDate)

This is a read-only attribute set by the server.

Parameters:

creationDate - date of creation

isExempt

public boolean isExempt()

Returns:

a flag for indicating whether the grade is exempt from grade calculation.

setExempt

public void setExempt(boolean exempt)

Parameters:

exempt - a flag for indicating whether the grade is exempt from grade calculation.

getExpansionData

public java.lang.String[] getExpansionData()

Returns:

expansion data

setExpansionData

public void setExpansionData(java.lang.String[] expansionData)

If you wish to create an attempt in IN PROGRESS status, add the expansion data: setStatusToInProgressAndIgnoreGrade=true

Parameters:

expansionData - expansionData the expansion data to set

getFeedbackToUser

public java.lang.String getFeedbackToUser()

Returns:

instructor's feedback

setFeedbackToUser

public void setFeedbackToUser(java.lang.String feedbackToUser)

Parameters:

feedbackToUser - instructor's feedback

getGrade

public java.lang.String getGrade()

Returns:

text grade

setGrade

public void setGrade(java.lang.String grade)

Parameters:

grade - text grade

getGradeId

public java.lang.String getGradeId()

Returns:

id of the associated ScoreVO object

setGradeId

public void setGradeId(java.lang.String gradeId)

Parameters:

gradeId - id of the associated ScoreVO object

getId

public java.lang.String getId()

Returns:

id of attempt

setId

public void setId(java.lang.String id)

Parameters:

id - id of the attempt

getInstructorNotes

public java.lang.String getInstructorNotes()

Returns:

notes from the instructor.

setInstructorNotes

public void setInstructorNotes(java.lang.String instructorNotes)

Parameters:

instructorNotes - notes from instructor

See Also:

GradebookWSConstants.INSTRUCTOR_COMMENTS_TEXT_TYPE

isOverride

public boolean isOverride()

Means the grade has been changed outside of the attempt container itself (i.e. from within the grade center, not from, for example, within the view attempt page from the assessment or assignment). This is introduced to support the notion of override to group attempt score but can possibly be extended to other tools as long as the tool keeps its own value for the attempt that could differ from the one in grade center.

Returns:

true if grade (or comments) have been changed from within the grade center.

setOverride

public void setOverride(boolean override)

Parameters:

override - flag which indicates whether it has been overridden.

getScore

public double getScore()

Returns:

numerical score

setScore

public void setScore(double score)

Parameters:

score - numerical score

getStatus

public java.lang.String getStatus()

This is a read-only attribute set by the server.

Returns:

status

setStatus

public void setStatus(java.lang.String status)

This is a read-only attribute set by the server.

Parameters:

status - status

getStudentComments

public java.lang.String getStudentComments()

Returns:

student comments

setStudentComments

public void setStudentComments(java.lang.String studentComments)

Parameters:

studentComments - student comments

See Also:

GradebookWSConstants.STUDENT_COMMENTS_TEXT_TYPE

getStudentSubmission

public java.lang.String getStudentSubmission()

Returns:

content of student submission

setStudentSubmission

public void setStudentSubmission(java.lang.String studentSubmission)

Parameters:

studentSubmission - content of student submission

getGroupAttemptId

public java.lang.String getGroupAttemptId()

Returns:

id of the group attempt

setGroupAttemptId

public void setGroupAttemptId(java.lang.String groupAttemptId)

Parameters:

groupAttemptId - id of the group attempt

isPublicFeedbackToUser

public boolean isPublicFeedbackToUser()

Returns:

flag to indicate whether to release feedback to user.

setPublicFeedbackToUser

public void setPublicFeedbackToUser(boolean publicFeedbackToUser)

Parameters:

publicFeedbackToUser - flag to indicate whether to release feedback to user.

getStudentSubmissionTextType

public java.lang.String getStudentSubmissionTextType()

Returns:

text type of submission text.

setStudentSubmissionTextType

public void setStudentSubmissionTextType(java.lang.String studentSubmissionTextType)

Possible values are:

• HTML
• PLAIN_TEXT
• SMART_TEXT

If not specified or an invalid value is specified then SMART_TEXT is assumed.

Parameters:

studentSubmissionTextType - text type of submission text.

getDisplayGrade

public java.lang.String getDisplayGrade()

If status is not set, "-" is returned. If grade is not set or grade is "!", "" is returned. If grade and score both set and are different and score is not 0.0, score is returned. If grade and score both set and are different and score is 0.0, grade is returned. (This can happen for gradable items with text display mode.)

This is a read-only attribute set by the server.

Returns:

the grade to show

setDisplayGrade

public void setDisplayGrade(java.lang.String displayGrade)

This is a read-only attribute set by the server.

Parameters:

displayGrade - grade to show