artemis.jh

entity Statistic (quizStatistic) {      //abstract
    participantsRated Integer,
    participantsUnrated Integer
}

entity QuizPointStatistic (quizPointStatistic) { //extends Statistic
}

entity QuizQuestionStatistic (quizQuestionStatistic) {   //extends Statistic, abstract
    ratedCorrectCounter Integer,
    unRatedCorrectCounter Integer,
}

entity MultipleChoiceQuestionStatistic (mcQuestionStatistic) {   //extends QuizQuestionStatistic
}

entity DragAndDropQuestionStatistic (dndQuestionStatistic) {   //extends QuizQuestionStatistic
}

entity ShortAnswerQuestionStatistic (saQuestionStatistic) {   //extends QuizQuestionStatistic
}

entity StatisticCounter(quizStatisticCounter) { //abstract
    ratedCounter Integer,
    UnRatedCounter Integer
}

entity PointCounter(pointCounter) {         //extends PointCounter
    points Double
}

entity AnswerCounter(answerCounter) {       //extends StatisticCounter
}

entity DropLocationCounter(dropLocationCounter) {    //extends StatisticCounter
}

entity ShortAnswerSpotCounter(shortAnswerSpotCounter) {    //extends StatisticCounter
}

entity Course (course) {
    title String,
    description String,        //LONGTEXT --> lob
    shortName String,
    studentGroupName String,
    teachingAssistantGroupName String,
    instructorGroupName String,
    startDate ZonedDateTime,
    endDate ZonedDateTime,
    onlineCourse Boolean,
    maxComplaints Integer,
    defaultProgrammingLanguage String,
    color String,
    courseIcon String,
    registrationEnabled Boolean
}

entity Exercise (exercise) {        //abstract
    problemStatement String,        //LONGTEXT --> lob
    gradingInstructions String,     //LONGTEXT --> lob
    title String,
    shortName String,
    releaseDate ZonedDateTime,
    dueDate ZonedDateTime,
    assessmentDueDate ZonedDateTime,
    maxScore Double,
    assessmentType AssessmentType,
    difficulty DifficultyLevel,
    mode ExerciseMode,
    categories String               //List<String>, similar to User --> groups
}

enum DifficultyLevel {
	EASY,
    MEDIUM,
    HARD
}

enum ExerciseMode {
	INDIVIDUAL,
    TEAM
}

entity TextExercise {               //extends Exercise
    sampleSolution String           //LONGTEXT --> lob
}

entity FileUploadExercise {         //extends Exercise
    filePattern String
}

entity ProgrammingExercise {        //extends Exercise
    testRepositoryUrl String,
    publishBuildPlanUrl Boolean,
    allowOnlineEditor Boolean,
    programmingLanguage ProgrammingLanguage,
    packageName String
}

enum ProgrammingLanguage {
    JAVA,
    PYTHON,
    C,
    HASKELL,
    KOTLIN,
    VHDL,
    ASSEMBLER,
    SWIFT,
    OCAML
}

entity ModelingExercise {           //extends Exercise
    diagramType DiagramType,
    sampleSolutionModel String,      //LONGTEXT --> lob
    sampleSolutionExplanation String //LONGTEXT --> lob
}

enum DiagramType {
	CLASS,
    ACTIVITY,
    USE_CASE,
    COMMUNICATION
}

entity QuizExercise {               //extends Exercise
    description String,
    explanation String,
    randomizeQuestionOrder Boolean,
    allowedNumberOfAttempts Integer,
	isVisibleBeforeStart Boolean,
    isOpenForPractice Boolean,
    isPlannedToStart Boolean,
    duration Integer
}

entity LtiOutcomeUrl (lti_outcome_url) {
    url String,
    sourcedId String
}

entity SubmittedAnswer {            //abstract
    scoreInPoints Double
}

entity QuizQuestion {                   //abstract
	title String,
    text String,
    hint String,
    explanation String,
    score Integer,
    scoringType ScoringType,
    randomizeOrder Boolean,
    invalid Boolean
}

enum ScoringType {
	ALL_OR_NOTHING,
    PROPORTIONAL_WITH_PENALTY,
    PROPORTIONAL_WITHOUT_PENALTY
}

entity MultipleChoiceQuestion {             //extends QuizQuestion

}

entity AnswerOption {
	text String,
    hint String,
    explanation String,
    isCorrect Boolean,
    invalid Boolean
}

entity MultipleChoiceSubmittedAnswer (mcSubmittedAnswer) {      //extends SubmittedAnswer

}

entity DragAndDropQuestion {          //extends QuizQuestion
	backgroundFilePath String
}

entity DropLocation {
	posX Integer
    posY Integer
    width Integer
    height Integer
    invalid Boolean
}

entity DragItem {
	pictureFilePath String
    text String
    invalid Boolean
}

entity ShortAnswerQuestion {          //extends QuizQuestion

}

entity ShortAnswerSpot {
	width Integer,
	spotNr Integer,
    invalid Boolean,
}

entity ShortAnswerSolution {
    text String
    invalid Boolean
}

entity Team {
    name String
    image String
}

entity TeamAssignmentConfig {
    minTeamSize Integer
    maxTeamSize Integer
}

entity Participation (participation) {
    repositoryUrl String,
    buildPlanId String,
    initializationState InitializationState,
    initializationDate ZonedDateTime,
    presentationScore Integer
}

entity LtiUserId (lti_user_id) {
    ltiUserId String
}

entity ExerciseResult (result) {
    completionDate ZonedDateTime,
    successful Boolean,
    buildArtifact Boolean,
    score Long,
    rated Boolean,
    hasFeedback Boolean,
    assessmentType AssessmentType,
    hasComplaint Boolean,
    exampleResult Boolean
}

enum AssessmentType {
    AUTOMATIC,
    SEMI_AUTOMATIC,
    MANUAL
}

entity Feedback(feedback) {
	text String,
	detailText String,
	reference String,
	credits Double,
	positive Boolean,
	type FeedbackType
}

enum FeedbackType {
    AUTOMATIC,
    MANUAL
}

enum InitializationState {
    UNINITIALIZED,
    REPO_COPIED,
    REPO_CONFIGURED,
    BUILD_PLAN_COPIED,
    BUILD_PLAN_CONFIGURED,
    INITIALIZED
}

enum SubmissionType {
	MANUAL,
    TIMEOUT,
    TEST,
    OTHER
}

entity Submission {                 //abstract
	submitted Boolean
	submissionDate ZonedDateTime,
    type SubmissionType,
    exampleSubmission Boolean
}

entity ModelingSubmission {         //extends Submission
	model String,                   //LONGTEXT --> lob
	explanationText String          //LONGTEXT --> lob
}

entity QuizSubmission {             //extends Submission
    scoreInPoints Double
}

entity ProgrammingSubmission {      //extends Submission
    commitHash String
}

entity TextSubmission {             //extends Submission
    text String                     //LONGTEXT --> lob
}

entity TextBlock {
    id String
    text String
    startIndex Integer
    endIndex   Integer
}

entity TextCluster {
    probabilities Blob
    distanceMatrix Blob
}

entity FileUploadSubmission {       //extends Submission
    filePath String
}

entity ExampleSubmission {
    usedForTutorial Boolean
}

entity DragAndDropSubmittedAnswer (dndSubmittedAnswer) {      //extends SubmittedAnswer

}

entity DragAndDropMapping {
	dragItemIndex Integer
    dropLocationIndex Integer
    invalid Boolean
}

entity ShortAnswerSubmittedAnswer (saSubmittedAnswer) {      //extends SubmittedAnswer
}

entity ShortAnswerSubmittedText (shortAnswerSubmittedText) {
    text String,
    isCorrect Boolean
}

entity ShortAnswerMapping {
	shortAnswerSpotIndex Integer
    shortAnswerSolutionIndex Integer
    invalid Boolean
}

entity ApollonDiagram {
    title String
    jsonRepresentation String       // LONGTEXT --> lob
}

entity Complaint {
    complaintText String,
    accepted Boolean,
    submittedTime ZonedDateTime,
    resultBeforeComplaint String    // LONGTEXT --> lob
}

entity ComplaintResponse {
    responseText String
    submittedTime ZonedDateTime
}

entity TutorParticipation {
    status TutorParticipationStatus,
    points Integer
}

enum TutorParticipationStatus {
    NOT_PARTICIPATED,
    REVIEWED_INSTRUCTIONS,
    TRAINED,
    COMPLETED
}

entity TutorGroup {
    name String,
    capacity Integer,
    weekday Weekday,
    timeSlot String,
    language Language,
    room String
}

enum Weekday {
    MONDAY,
    TUESDAY,
    WEDNESDAY,
    THURSDAY,
    FRIDAY
}

enum Language {
    ENGLISH,
    GERMAN
}

entity Notification {
    title String,
    text String,                       // LONGTEXT --> lob
    notificationDate ZonedDateTime,
    target String
}

entity SystemNotification {             // extends Notification
    expireDate ZonedDateTime,
    type SystemNotificationType,
}

entity GroupNotification {             // extends Notification
    type GroupNotificationType
}

entity SingleUserNotification {        // extends Notification

}

enum GroupNotificationType {
    INSTRUCTOR,
    TA,
    STUDENT
}

enum SystemNotificationType {
    WARNING,
    INFO
}

entity Lecture {
    title String,
    description String,               // LONGTEXT --> lob
    startDate ZonedDateTime,
    endDate ZonedDateTime
}

entity Attachment {
    name String,
    link String,
    version Integer,
    uploadDate ZonedDateTime,
    releaseDate ZonedDateTime,
    attachmentType AttachmentType
}

enum AttachmentType {
    FILE,
    URL
}

entity ModelAssessmentConflict {
    state EscalationState,
    creationDate ZonedDateTime,
    resolutionDate ZonedDateTime
}

entity ConflictingResult {
    modelElementId String
}

enum EscalationState {
    UNHANDLED,
    ESCALATED_TO_TUTORS_IN_CONFLICT,
    ESCALATED_TO_INSTRUCTOR,
    RESOLVED_BY_CAUSER,
    RESOLVED_BY_OTHER_TUTORS,
    RESOLVED_BY_INSTRUCTOR
}


relationship OneToMany {
    QuizPointStatistic{PointCounters} to PointCounter{quizPointStatistic},
    MultipleChoiceQuestionStatistic{AnswerCounters} to AnswerCounter{MultipleChoiceQuestionStatistic},
    DragAndDropQuestionStatistic{DropLocationCounters} to DropLocationCounter{DragAndDropQuestionStatistic},
    ShortAnswerQuestionStatistic{ShortAnswerSpotCounters} to ShortAnswerSpotCounter{ShortAnswerQuestionStatistic},
    Course{exercises} to Exercise{course},
    Course{lectures} to Lecture{course},
    Course{tutorGroups} to TutorGroup{course},
    Exercise{participations} to Participation{exercise},
    Exercise{tutorParticipations} to TutorParticipation{assessedExercise},
    Participation{results} to ExerciseResult{participation},
    Participation{submissions} to Submission{participation},
    ExerciseResult{feedbacks} to Feedback{result},
    QuizExercise{quizQuestions} to QuizQuestion{exercise},
    MultipleChoiceQuestion{answerOptions} to AnswerOption{quizQuestion},
    DragAndDropQuestion{dropLocations} to DropLocation{quizQuestion},
    DragAndDropQuestion{dragItems} to DragItem{quizQuestion},
    ShortAnswerQuestion{spots} to ShortAnswerSpot{quizQuestion},
    ShortAnswerQuestion{solutions} to ShortAnswerSolution{quizQuestion},
    QuizSubmission{submittedAnswers} to SubmittedAnswer{submission},
    DragAndDropSubmittedAnswer{mappings} to DragAndDropMapping{submittedAnswer},
    DragAndDropQuestion{correctMappings} to DragAndDropMapping{quizQuestion},
    ShortAnswerQuestion{correctMappings} to ShortAnswerMapping{quizQuestion}
    ShortAnswerSubmittedAnswer{submittedTexts} to ShortAnswerSubmittedText{submittedAnswer},
    Exercise{exampleSubmissions} to ExampleSubmission{exercise}
    Lecture{attachments} to Attachment{lecture},
    Exercise{attachments} to Attachment{exercise},
    ModelAssessmentConflict{resultsInConflict} to ConflictingResult{conflict},
    TextSubmission{blocks} to TextBlock{submission},
    TextCluster{blocks} to TextBlock{cluster},
    TextExercise{clusters} to TextCluster{exercise}
}

relationship OneToOne {
    QuizExercise{quizPointStatistic} to QuizPointStatistic{quiz},
    QuizQuestion{quizQuestionStatistic} to QuizQuestionStatistic{quizQuestion},
    AnswerCounter{answer} to AnswerOption,
    DropLocationCounter{dropLocation} to DropLocation,
    ShortAnswerSpotCounter{spot} to ShortAnswerSpot,
    ShortAnswerSubmittedText{spot} to ShortAnswerSpot,
    Submission{result} to ExerciseResult{submission},
    LtiUserId{user} to User,
    ExerciseResult{assessor} to User,
    Complaint{result} to ExerciseResult,
    ComplaintResponse{complaint} to Complaint,
    ExampleSubmission{submission} to Submission,
    ProgrammingExercise{templateParticipation} to Participation,
    ProgrammingExercise{solutionParticipation} to Participation,
    ModelAssessmentConflict{causingConflictingResult} to ConflictingResult,
    ModelAssessmentConflict{updatedFeedback} to Feedback,
    Exercise{teamAssignmentConfig} to TeamAssignmentConfig{exercise},
}

relationship ManyToOne {
    TutorGroup{tutor} to User,
    Team{exercise} to Exercise,
    Participation{student} to User,
    Participation{team} to Team,
    LtiOutcomeUrl{user} to User,
    LtiOutcomeUrl{exercise} to Exercise,
    SubmittedAnswer{quizQuestion} to QuizQuestion
    DragAndDropMapping{dragItem} to DragItem,
    DragAndDropMapping{dropLocation} to DropLocation,
    ShortAnswerMapping{solution} to ShortAnswerSolution,
    ShortAnswerMapping{spot} to ShortAnswerSpot,
    TutorParticipation{tutor} to User,
    Notification{author} to User,
    SingleUserNotification{recipient} to User,
    GroupNotification{course} to Course,
    Complaint{student} to User,
    ComplaintResponse{reviewer} to User,
    ModelAssessmentConflict{result} to ExerciseResult,
}

relationship ManyToMany {
    Team{students} to User,    //Note: there should be a constraint that per exercise/course (depending on team scope) a student can only be in one team at the same time
    TutorGroup{students} to User,    //Note: there should be a constraint that per course a student can only be in one tutor group at the same time
	MultipleChoiceSubmittedAnswer{selectedOptions} to AnswerOption,
	TutorParticipation{trainedExampleSubmissions} to ExampleSubmission{tutorParticipations},
}

service Course with serviceClass
service Participation with serviceClass