org.sakaiproject.assignment.api.model.Assignment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sakai-assignment-api Show documentation
The newest version!
/**********************************************************************************
 * $URL$
 * $Id$
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 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.assignment.api.model;

import java.time.Instant;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.persistence.CascadeType;
import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.MapKeyColumn;
import javax.persistence.OneToMany;
import javax.persistence.Table;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.Type;

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.JsonManagedReference;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;

/**
 * Assignment represents a specific assignment for a specific section or class.
 * 
 * 
Important notes about Java java.util.Date timezone persistence
 *  * * MySQL DATETIME vs TIMESTAMP
 *   - DATETIME is a date and time and has a much wider range than TIMESTAMP. MySQL's date operations
 *     can be used to perform date calculations. Probably the most notable trait is that the value that
 *     is stored will be the same when retrieved regardless of timezone info. This shifts the
 *     responsibility to the application to handling timezone info. Changing the server/jvm timezone
 *     would result in different times if not handled.
 *     It's best canonicalized with DATETIME is not affected by timezones.
 *   - TIMESTAMP is a specific point in time (uses 4 bytes making it more efficient in mysql).
 *     Values are converted from the current timezone to UTC for storage and then converted back
 *     from UTC to the current timezone. The current timezone is usually the mysql servers timezone.
 *     Changing the server/jvm timezone wouldn't matter.
 *   - Connector/J useLegacyDatetimeCode is used for backwards compatibility, handling timezone info
 *     the way it always has. Newer versions will probably change this to false. The general rule of thumb
 *     is to use whatever your database was running with (i.e. true), and new databases with new data to use false.
 *   - Connector/J 5.1.x useLegacyDatetimeCode=true and > 5.1 is false
 *   - MariaDB Connector/J 1.1.7+ useLegacyDatetimeCode=true
 * * Hibernate
 *   - JPA @Temporal creates a TIMESTAMP type in MYSQL by default
 *   - java 8 time is supported natively in Hibernate 5
 *     - where @Temporal is implicit and therefore not needed
 *     - LocalDate implicitly @Temporal(TemporalType.Date)
 *     - LocalTime implicitly @Temporal(TemporalType.Time)
 *     - LocalDateTime implicitly @Temporal(TemporalType.Timestamp)
 *   - java 8 time Instant is not a supported Type in Hibernate < 5
 *     - So we use a custom type called org.hibernate.type.InstantType,
 *       which stores the time consistent with the use of Instant in UTC in a DATETIME field.
 *       This can be removed after upgrading to Hibernate 5.
 * 
 */

@Entity
@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
@Table(name = "ASN_ASSIGNMENT", indexes = {
        @Index(name = "IDX_ASN_ASSIGNMENT_CONTEXT", columnList = "CONTEXT")
})
@Data
@NoArgsConstructor
@ToString(exclude = {"authors", "submissions", "groups", "properties", "attachments"})
@EqualsAndHashCode(of = "id")
@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
@JsonIgnoreProperties(ignoreUnknown = true)
public class Assignment {

    @Id
    @Column(name = "ASSIGNMENT_ID", length = 36, nullable = false)
    @GeneratedValue(generator = "uuid")
    @GenericGenerator(name = "uuid", strategy = "uuid2")
    private String id;

    @Column(name = "TITLE")
    private String title;

    @Lob
    @Column(name = "INSTRUCTIONS", length = 65535)
    private String instructions;

    @Column(name = "CONTEXT", length = 99, nullable = false)
    private String context;

    @Column(name = "SECTION")
    private String section;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "CREATED_DATE", nullable = false)
    private Instant dateCreated;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "MODIFIED_DATE")
    private Instant dateModified;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "VISIBLE_DATE")
    private Instant visibleDate;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "OPEN_DATE")
    private Instant openDate;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "DUE_DATE")
    private Instant dueDate;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "CLOSE_DATE")
    private Instant closeDate;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "DROP_DEAD_DATE")
    private Instant dropDeadDate;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "SOFT_REMOVED_DATE")
    private Instant softRemovedDate;

    @Column(name = "MODIFIER", length = 99)
    private String modifier;

    @Column(name = "AUTHOR", length = 99)
    private String author;

    @Column(name = "DRAFT", nullable = false)
    private Boolean draft = Boolean.FALSE;

    @Column(name = "DELETED")
    private Boolean deleted = Boolean.FALSE;

    @Column(name = "HIDE_DUE_DATE")
    private Boolean hideDueDate = Boolean.FALSE;

    @Column(name = "IS_GROUP")
    private Boolean isGroup = Boolean.FALSE;

    @Column(name = "POSITION")
    private Integer position;

    @OneToMany(mappedBy = "assignment", cascade = CascadeType.ALL, orphanRemoval = true)
    @JsonManagedReference
    private Set submissions = new HashSet<>();

    @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
    @ElementCollection
    @MapKeyColumn(name = "NAME")
    @Column(name = "VALUE", length = 4000)
    @CollectionTable(name = "ASN_ASSIGNMENT_PROPERTIES", joinColumns = @JoinColumn(name = "ASSIGNMENT_ID"), indexes = @Index(name="FK_ASN_ASSIGMENTS_PROP_I", columnList = "ASSIGNMENT_ID"))
    @Fetch(FetchMode.SUBSELECT)
    private Map properties = new HashMap<>();

    @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
    @ElementCollection
    @CollectionTable(name = "ASN_ASSIGNMENT_GROUPS", joinColumns = @JoinColumn(name = "ASSIGNMENT_ID"), indexes = @Index(columnList = "ASSIGNMENT_ID"))
    @Fetch(FetchMode.SUBSELECT)
    @Column(name = "GROUP_ID")
    private Set groups = new HashSet<>();

    @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
    @ElementCollection
    @CollectionTable(name = "ASN_ASSIGNMENT_ATTACHMENTS", joinColumns = @JoinColumn(name = "ASSIGNMENT_ID"), indexes = @Index(columnList = "ASSIGNMENT_ID"))
    @Fetch(FetchMode.SUBSELECT)
    @Column(name = "ATTACHMENT", length = 1024)
    private Set attachments = new HashSet<>();

    @Enumerated(value = EnumType.STRING)
    @Column(name = "ACCESS_TYPE", nullable = false)
    private Access typeOfAccess = Access.SITE;

    @Column(name = "HONOR_PLEDGE")
    private Boolean honorPledge = Boolean.FALSE;

    @Enumerated
    @Column(name = "SUBMISSION_TYPE")
    private SubmissionType typeOfSubmission = SubmissionType.ASSIGNMENT_SUBMISSION_TYPE_NONE;

    @Enumerated
    @Column(name = "GRADE_TYPE")
    private GradeType typeOfGrade = GradeType.GRADE_TYPE_NONE;

    @Column(name = "MAX_GRADE_POINT")
    private Integer maxGradePoint;

    @Column(name = "SCALE_FACTOR")
    private Integer scaleFactor;

    @Column(name = "INDIVIDUALLY_GRADED")
    private Boolean individuallyGraded;

    @Column(name = "RELEASE_GRADES")
    private Boolean releaseGrades = Boolean.FALSE;

    @Column(name = "ALLOW_ATTACHMENTS")
    private Boolean allowAttachments;

    @Column(name = "ALLOW_PEER_ASSESSMENT")
    private Boolean allowPeerAssessment = Boolean.FALSE;

    @Type(type = "org.hibernate.type.InstantType")
    @Column(name = "PEER_ASSESSMENT_PERIOD_DATE")
    private Instant peerAssessmentPeriodDate;

    @Column(name = "PEER_ASSESSMENT_ANON_EVAL")
    private Boolean peerAssessmentAnonEval;

    @Column(name = "PEER_ASSESSMENT_STUDENT_REVIEW")
    private Boolean peerAssessmentStudentReview = Boolean.FALSE;

    @Column(name = "PEER_ASSESSMENT_NUMBER_REVIEW")
    private Integer peerAssessmentNumberReviews;

    @Lob
    @Column(name = "PEER_ASSESSMENT_INSTRUCTIONS", length = 65535)
    private String peerAssessmentInstructions;

    @Column(name = "CONTENT_REVIEW")
    private Boolean contentReview = Boolean.FALSE;

    @Column(name = "ESTIMATE_REQUIRED", length = 1, nullable = false)
    private Boolean estimateRequired = Boolean.FALSE;

    @Column(name = "ESTIMATE", length = 255)
    private String estimate;

    @Column(name = "CONTENT_ID")
    private Integer contentId = null;

    @Column(name = "CONTENT_LAUNCH_NEW_WINDOW")
    private Boolean contentLaunchNewWindow = Boolean.FALSE;

    public enum Access {
        SITE,
        GROUP
    }

    public enum SubmissionType {
        ASSIGNMENT_SUBMISSION_TYPE_NONE,           // 0
        TEXT_ONLY_ASSIGNMENT_SUBMISSION,           // 1
        ATTACHMENT_ONLY_ASSIGNMENT_SUBMISSION,     // 2
        TEXT_AND_ATTACHMENT_ASSIGNMENT_SUBMISSION, // 3
        NON_ELECTRONIC_ASSIGNMENT_SUBMISSION,      // 4
        SINGLE_ATTACHMENT_SUBMISSION,              // 5
        EXTERNAL_TOOL_SUBMISSION,                  // 6
        VIDEO_SUBMISSION                           // 7
    }

    public enum GradeType {
        GRADE_TYPE_NONE,      // 0
        UNGRADED_GRADE_TYPE,  // 1
        LETTER_GRADE_TYPE,    // 2
        SCORE_GRADE_TYPE,     // 3
        PASS_FAIL_GRADE_TYPE, // 4
        CHECK_GRADE_TYPE      // 5
    }
}