AssessmentGradingData.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/sam/trunk/samigo-api/src/java/org/sakaiproject/tool/assessment/data/dao/grading/AssessmentGradingData.java $
 * $Id: AssessmentGradingData.java 121258 2013-03-15 15:03:36Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2004, 2005, 2006, 2008, 2009 The Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.opensource.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **********************************************************************************/

package org.sakaiproject.tool.assessment.data.dao.grading;

import java.util.Date;
import java.util.HashSet;
import java.util.Set;

/**
 * Represents a students response on a particular quiz
 * 
 * 
 */
public class AssessmentGradingData implements java.io.Serializable
// need to implement org.osid.assessment.ItemTaken in the future
// - daisyf 10/11/04
{
	private static final long serialVersionUID = 7526471155622776147L;

	private Long assessmentGradingId;
	private String agentId;
	// private PublishedAssessmentIfc publishedAssessment;
	private Date submittedDate;
	private Boolean isLate;
	private Boolean forGrade;
	private Double totalAutoScore;
	private Double totalOverrideScore;
	private Double finalScore; // final total score
	private String comments;
	private Integer status;
	private String gradedBy;
	private Date gradedDate;
	private Set<ItemGradingData> itemGradingSet = new HashSet<ItemGradingData>();
	private Date attemptDate;
	private Integer timeElapsed;
	private int totalSubmitted;
	private Long publishedAssessmentId;
	private String publishedAssessmentTitle;
	private Boolean isAutoSubmitted;
	private Integer lastVisitedPart = 0;
	private Integer lastVisitedQuestion = 0;
	private Boolean hasAutoSubmissionRun = false;

	// Because of SAK-16456, we no longer need to show the auto/human graded
	// status per submission, I don't think we
	// need to distinguish status 2 and 3 anymore. But I just leave them here...

	/**
	 * status = 1: submit but not grade yet
	 */
	public static final Integer SUBMITTED = Integer.valueOf(1);
	/**
	 * status = 2: grader has went to total score page and graded + AUTO_GRADED
	 */
	public static final Integer AUTO_GRADED = Integer.valueOf(2);

	/**
	 * status = 3: grader has went to total score page and graded + at least one
	 * question NEED_HUMAN_ATTENTION
	 */
	public static final Integer NEED_HUMAN_ATTENTION = Integer.valueOf(3);

	/**
	 * status = 4: the assessment has be republished. This assessment has been
	 * submitted. Therefore, this it needs to be resubmit
	 */
	public static final Integer ASSESSMENT_UPDATED_NEED_RESUBMIT = Integer
			.valueOf(4);

	/**
	 * status = 5: there is no submission but grader update something in the
	 * score page
	 */
	public static final Integer NO_SUBMISSION = Integer.valueOf(5);

	/**
	 * status = 6: the assessment has be republished. This assessment has begun
	 * but not yet been submitted (saved/in progress). Therefore, just warn the
	 * student about the update ("resubmit" is not applicable here).
	 */
	public static final Integer ASSESSMENT_UPDATED = Integer.valueOf(6);

	public AssessmentGradingData() {
	}

	// this constructor do not contains Set of ItemGradingData
	public AssessmentGradingData(Long assessmentGradingId,
			Long publishedAssessmentId, String publishedAssessmentTitle,
			String agentId, Date submittedDate, Boolean isLate,
			Boolean forGrade, Double totalAutoScore, Double totalOverrideScore,
			Double finalScore, String comments, Integer status, String gradedBy,
			Date gradedDate, Date attemptDate, Integer timeElapsed,
			Boolean isAutoSubmitted) {
		this.assessmentGradingId = assessmentGradingId;
		this.publishedAssessmentId = publishedAssessmentId;
		this.publishedAssessmentTitle = publishedAssessmentTitle;
		this.agentId = agentId;
		this.submittedDate = submittedDate;
		this.isLate = isLate;
		this.forGrade = forGrade;
		this.totalAutoScore = totalAutoScore;
		this.totalOverrideScore = totalOverrideScore;
		this.finalScore = finalScore;
		this.comments = comments;
		this.status = status;
		this.gradedBy = gradedBy;
		this.gradedDate = gradedDate;
		this.attemptDate = attemptDate;
		this.timeElapsed = timeElapsed;
		this.isAutoSubmitted = isAutoSubmitted;
	}

	public AssessmentGradingData(Long assessmentGradingId,
			Long publishedAssessmentId, String publishedAssessmentTitle,
			String agentId, Date submittedDate, Boolean isLate,
			Boolean forGrade, Double totalAutoScore, Double totalOverrideScore,
			Double finalScore, String comments, Integer status, String gradedBy,
			Date gradedDate, Date attemptDate, Integer timeElapsed) {
		this(assessmentGradingId, publishedAssessmentId,
				publishedAssessmentTitle, agentId, submittedDate, isLate,
				forGrade, totalAutoScore, totalOverrideScore, finalScore,
				comments, status, gradedBy, gradedDate, attemptDate,
				timeElapsed, Boolean.valueOf(false));
	}

	public AssessmentGradingData(Long assessmentGradingId,
			Long publishedAssessmentId, String agentId, Date submittedDate,
			Boolean isLate, Boolean forGrade, Double totalAutoScore,
			Double totalOverrideScore, Double finalScore, String comments,
			Integer status, String gradedBy, Date gradedDate, Date attemptDate,
			Integer timeElapsed) {
		this.assessmentGradingId = assessmentGradingId;
		this.publishedAssessmentId = publishedAssessmentId;
		this.agentId = agentId;
		this.submittedDate = submittedDate;
		this.isLate = isLate;
		this.forGrade = forGrade;
		this.totalAutoScore = totalAutoScore;
		this.totalOverrideScore = totalOverrideScore;
		this.finalScore = finalScore;
		this.comments = comments;
		this.status = status;
		this.gradedBy = gradedBy;
		this.gradedDate = gradedDate;
		this.attemptDate = attemptDate;
		this.timeElapsed = timeElapsed;
	}

	public AssessmentGradingData(Long publishedAssessmentId, int totalSubmitted) {
		this.publishedAssessmentId = publishedAssessmentId;
		this.totalSubmitted = totalSubmitted;
	}

	public Long getAssessmentGradingId() {
		return assessmentGradingId;
	}

	public void setAssessmentGradingId(Long assessmentGradingId) {
		this.assessmentGradingId = assessmentGradingId;
	}

	public Long getPublishedAssessmentId() {
		return publishedAssessmentId;
	}

	public void setPublishedAssessmentId(Long publishedAssessmentId) {
		this.publishedAssessmentId = publishedAssessmentId;
	}

	public String getAgentId() {
		return agentId;
	}

	public void setAgentId(String agentId) {
		this.agentId = agentId;
	}

	public Date getSubmittedDate() {
		return submittedDate;
	}

	public void setSubmittedDate(Date submittedDate) {
		this.submittedDate = submittedDate;
	}

	public Boolean getIsLate() {
		return isLate;
	}

	public void setIsLate(Boolean isLate) {
		this.isLate = isLate;
	}

	public Boolean getForGrade() {
		return forGrade;
	}

	public void setForGrade(Boolean forGrade) {
		this.forGrade = forGrade;
	}

	public Double getTotalAutoScore() {
		return this.totalAutoScore;
	}

	public void setTotalAutoScore(Double totalAutoScore) {
		if (totalAutoScore != null) {
			if (totalAutoScore.doubleValue() < 0) {
				this.totalAutoScore = new Double("0");
			} else {
				this.totalAutoScore = totalAutoScore;
			}
		} else {
			this.totalAutoScore = null;
		}
	}

	public Double getTotalOverrideScore() {
		return this.totalOverrideScore;
	}

	public void setTotalOverrideScore(Double totalOverrideScore) {
		this.totalOverrideScore = totalOverrideScore;
	}

	public Double getFinalScore() {
		/*
		 * if (this.totalAutoScore != null && this.totalOverrideScore != null ){
		 * double total = 0; if (this.totalAutoScore != null) total +=
		 * this.totalAutoScore.doubleValue(); if (this.totalOverrideScore !=
		 * null) total += this.totalOverrideScore.doubleValue(); this.finalScore
		 * = new Double(total); }
		 * 
		 * // remove rounding , SAK-2848 // Round to the nearest 1/10th. if
		 * (this.finalScore !=null ){ double alignment =
		 * this.finalScore.doubleValue(); int tmp = Math.round(alignment *
		 * 10.0d); alignment = (double)tmp / 10.0d; this.finalScore = new
		 * Double(alignment); }
		 */
		return this.finalScore;
	}

	public void setFinalScore(Double finalScore) {
		this.finalScore = finalScore;
	}

	public String getComments() {
		return comments;
	}

	public void setComments(String comments) {
		this.comments = comments;
	}

	public String getGradedBy() {
		return gradedBy;
	}

	public void setGradedBy(String gradedBy) {
		this.gradedBy = gradedBy;
	}

	public Date getGradedDate() {
		return gradedDate;
	}

	public void setGradedDate(Date gradedDate) {
		this.gradedDate = gradedDate;
	}

	/**
	 * In some cases, students are allowed to submit multiple assessment for
	 * grading. However, the grader has the choice to select one to represent
	 * how well the student does overall. status = 1 means this submitted
	 * assessment is selected.
	 */
	// daisy's comment: I am not sure Integer(1) is being used at all. 11/18/05
	public Integer getStatus() {
		return status;
	}

	public void setStatus(Integer status) {
		this.status = status;
	}

	public Set<ItemGradingData> getItemGradingSet() {
		return itemGradingSet;
	}

	public void setItemGradingSet(Set<ItemGradingData> itemGradingSet) {
		this.itemGradingSet = itemGradingSet;
	}

	public Date getAttemptDate() {
		return attemptDate;
	}

	public void setAttemptDate(Date attemptDate) {
		this.attemptDate = attemptDate;
	}

	public Integer getTimeElapsed() {
		return timeElapsed;
	}

	public void setTimeElapsed(Integer timeElapsed) {
		this.timeElapsed = timeElapsed;
	}

	public int getTotalSubmitted() {
		return totalSubmitted;
	}

	public void setTotalSubmitted(int totalSubmitted) {
		this.totalSubmitted = totalSubmitted;
	}

	public String getPublishedAssessmentTitle() {
		return publishedAssessmentTitle;
	}

	public void setPublishedAssessmentTitle(String publishedAssessmentTitle) {
		this.publishedAssessmentTitle = publishedAssessmentTitle;
	}

	// daisy added this for mining partial assessmentGradingData object
	// 11/17/05
	private Long publishedItemId;

	private boolean isRecorded;

	public Long getPublishedItemId() {
		return publishedItemId;
	}

	public void setItemGradingId(Long publishedItemId) {
		this.publishedItemId = publishedItemId;
	}

	public AssessmentGradingData(Long assessmentGradingId,
			Long publishedItemId, String agentId, Double finalScore,
			Date submittedDate) {
		this.assessmentGradingId = assessmentGradingId;
		this.publishedItemId = publishedItemId;
		this.agentId = agentId;
		this.finalScore = finalScore;
		this.submittedDate = submittedDate;
	}

	public Boolean getIsAutoSubmitted() {
		return isAutoSubmitted;
	}

	public void setIsAutoSubmitted(Boolean isAutoSubmitted) {
		this.isAutoSubmitted = isAutoSubmitted;
	}

	public Integer getLastVisitedPart() {
		return lastVisitedPart;
	}

	public void setLastVisitedPart(Integer lastVisitedPart) {
		this.lastVisitedPart = lastVisitedPart;
	}

	public Integer getLastVisitedQuestion() {
		return lastVisitedQuestion;
	}

	public void setLastVisitedQuestion(Integer lastVisitedQuestion) {
		this.lastVisitedQuestion = lastVisitedQuestion;
	}

	public boolean getIsRecorded() {
		return isRecorded;
	}

	public void setIsRecorded(boolean isRecorded) {
		this.isRecorded = isRecorded;
	}

	public Boolean getHasAutoSubmissionRun() {
		  return hasAutoSubmissionRun;
	  }

	  public void setHasAutoSubmissionRun(Boolean hasAutoSubmissionRun) {
		  this.hasAutoSubmissionRun = hasAutoSubmissionRun;
	  }

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((agentId == null) ? 0 : agentId.hashCode());
		result = prime
				* result
				+ ((assessmentGradingId == null) ? 0 : assessmentGradingId
						.hashCode());
		result = prime * result
				+ ((attemptDate == null) ? 0 : attemptDate.hashCode());
		result = prime * result
				+ ((comments == null) ? 0 : comments.hashCode());
		result = prime * result
				+ ((finalScore == null) ? 0 : finalScore.hashCode());
		result = prime * result
				+ ((forGrade == null) ? 0 : forGrade.hashCode());
		result = prime * result
				+ ((gradedBy == null) ? 0 : gradedBy.hashCode());
		result = prime * result
				+ ((gradedDate == null) ? 0 : gradedDate.hashCode());
		result = prime * result
				+ ((isAutoSubmitted == null) ? 0 : isAutoSubmitted.hashCode());
		result = prime * result + ((isLate == null) ? 0 : isLate.hashCode());
		result = prime * result + (isRecorded ? 1231 : 1237);
		result = prime * result
				+ ((itemGradingSet == null) ? 0 : itemGradingSet.hashCode());
		result = prime * result
				+ ((lastVisitedPart == null) ? 0 : lastVisitedPart.hashCode());
		result = prime
				* result
				+ ((lastVisitedQuestion == null) ? 0 : lastVisitedQuestion
						.hashCode());
		result = prime
				* result
				+ ((publishedAssessmentId == null) ? 0 : publishedAssessmentId
						.hashCode());
		result = prime
				* result
				+ ((publishedAssessmentTitle == null) ? 0
						: publishedAssessmentTitle.hashCode());
		result = prime * result
				+ ((publishedItemId == null) ? 0 : publishedItemId.hashCode());
		result = prime * result + ((status == null) ? 0 : status.hashCode());
		result = prime * result
				+ ((submittedDate == null) ? 0 : submittedDate.hashCode());
		result = prime * result
				+ ((timeElapsed == null) ? 0 : timeElapsed.hashCode());
		result = prime * result
				+ ((totalAutoScore == null) ? 0 : totalAutoScore.hashCode());
		result = prime
				* result
				+ ((totalOverrideScore == null) ? 0 : totalOverrideScore
						.hashCode());
		result = prime * result + totalSubmitted;
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		AssessmentGradingData other = (AssessmentGradingData) obj;
		if (agentId == null) {
			if (other.agentId != null)
				return false;
		} else if (!agentId.equals(other.agentId))
			return false;
		if (assessmentGradingId == null) {
			if (other.assessmentGradingId != null)
				return false;
		} else if (!assessmentGradingId.equals(other.assessmentGradingId))
			return false;
		if (attemptDate == null) {
			if (other.attemptDate != null)
				return false;
		} else if (!attemptDate.equals(other.attemptDate))
			return false;
		if (comments == null) {
			if (other.comments != null)
				return false;
		} else if (!comments.equals(other.comments))
			return false;
		if (finalScore == null) {
			if (other.finalScore != null)
				return false;
		} else if (!finalScore.equals(other.finalScore))
			return false;
		if (forGrade == null) {
			if (other.forGrade != null)
				return false;
		} else if (!forGrade.equals(other.forGrade))
			return false;
		if (gradedBy == null) {
			if (other.gradedBy != null)
				return false;
		} else if (!gradedBy.equals(other.gradedBy))
			return false;
		if (gradedDate == null) {
			if (other.gradedDate != null)
				return false;
		} else if (!gradedDate.equals(other.gradedDate))
			return false;
		if (isAutoSubmitted == null) {
			if (other.isAutoSubmitted != null)
				return false;
		} else if (!isAutoSubmitted.equals(other.isAutoSubmitted))
			return false;
		if (isLate == null) {
			if (other.isLate != null)
				return false;
		} else if (!isLate.equals(other.isLate))
			return false;
		if (isRecorded != other.isRecorded)
			return false;
		if (itemGradingSet == null) {
			if (other.itemGradingSet != null)
				return false;
		} else if (!itemGradingSet.equals(other.itemGradingSet))
			return false;
		if (lastVisitedPart == null) {
			if (other.lastVisitedPart != null)
				return false;
		} else if (!lastVisitedPart.equals(other.lastVisitedPart))
			return false;
		if (lastVisitedQuestion == null) {
			if (other.lastVisitedQuestion != null)
				return false;
		} else if (!lastVisitedQuestion.equals(other.lastVisitedQuestion))
			return false;
		if (publishedAssessmentId == null) {
			if (other.publishedAssessmentId != null)
				return false;
		} else if (!publishedAssessmentId.equals(other.publishedAssessmentId))
			return false;
		if (publishedAssessmentTitle == null) {
			if (other.publishedAssessmentTitle != null)
				return false;
		} else if (!publishedAssessmentTitle
				.equals(other.publishedAssessmentTitle))
			return false;
		if (publishedItemId == null) {
			if (other.publishedItemId != null)
				return false;
		} else if (!publishedItemId.equals(other.publishedItemId))
			return false;
		if (status == null) {
			if (other.status != null)
				return false;
		} else if (!status.equals(other.status))
			return false;
		if (submittedDate == null) {
			if (other.submittedDate != null)
				return false;
		} else if (!submittedDate.equals(other.submittedDate))
			return false;
		if (timeElapsed == null) {
			if (other.timeElapsed != null)
				return false;
		} else if (!timeElapsed.equals(other.timeElapsed))
			return false;
		if (totalAutoScore == null) {
			if (other.totalAutoScore != null)
				return false;
		} else if (!totalAutoScore.equals(other.totalAutoScore))
			return false;
		if (totalOverrideScore == null) {
			if (other.totalOverrideScore != null)
				return false;
		} else if (!totalOverrideScore.equals(other.totalOverrideScore))
			return false;
		if (totalSubmitted != other.totalSubmitted)
			return false;
		return true;
	}

}