Merge pull request #51 from SELab-2/14-implement-logical-database-scheme

entity interfaces

Author: thomasdejaeghere

backend/src/core/entities/assignment_interface.ts

@@ -0,0 +1,16 @@
+import { GroupInterface } from "./group_interface";
+
+export interface AssignmentInterface {
+    id: string;
+    uuid: string;
+    start_date: Date;
+    deadline: Date;
+    extra_instructions: string;
+
+    set_start_date: (new_start_date: Date) => void;
+    set_deadline: (new_deadline: Date) => void;
+    set_extra_instructions: (new_instructions: string) => void;
+
+    get_groups: () => [GroupInterface];
+
+}

backend/src/core/entities/class_interface.ts

@@ -0,0 +1,23 @@
+import { AssignmentInterface } from "./assignment_interface";
+import { GroupInterface } from "./group_interface";
+import { StudentInterface } from "./student_interface";
+import { TeacherInterface } from "./teacher_interface";
+
+export interface ClassInterface {
+    id: string;
+    name: string;
+    year: number;
+
+    set_year: (new_year: number) => void;
+    set_name: (new_name: string) => void;
+
+    get_teachers: () => [TeacherInterface]; // Get this class' teachers.
+    get_students: () => [StudentInterface]; // Get this class' students.
+    create_invite_link: () => string; // Create an invite link for teachers and students to join the class.
+
+    get_assignments: () => [AssignmentInterface]; // Get the assignments for this class.
+    create_assignment: () => AssignmentInterface; // Create a new assignment.
+
+    get_all_groups: () => [GroupInterface]; // Get all existing groups that consist exclusively of students from this class.
+
+}

backend/src/core/entities/group_interface.ts

@@ -0,0 +1,6 @@
+import { ClassInterface } from "./class_interface";
+
+export interface GroupInterface {
+    id: string;
+    class: ClassInterface;
+}

backend/src/core/entities/join_requests_interface.ts

@@ -0,0 +1,9 @@
+import { ClassInterface } from "./class_interface"
+import { UserInterface } from "./user_interface";
+
+export interface JoinRequestsInterface {
+    get_class: () => ClassInterface; // Get the class that the users request to join.
+    get_join_requests: () => [UserInterface]; // Get one list with both all students wanting to join and all teachers wanting to join.
+    accept: (student_or_teacher: UserInterface) => void; // Accept a teacher or student (from the join request list) to enter the class.
+    deny: (student_or_teacher: UserInterface) => void; // Deny a teacher or student (from the join request list) to enter the class.
+}

backend/src/core/entities/student_interface.ts

@@ -0,0 +1,7 @@
+import { AssignmentInterface } from "./assignment_interface";
+import { UserInterface } from "./user_interface";
+
+export interface StudentInterface extends UserInterface {
+    ask_question_for_assignment: (assignment: AssignmentInterface) => void; // TODO: correct arguments.
+    send_submission_for_assignment: (assignment: AssignmentInterface) => void;
+}

backend/src/core/entities/teacher.ts

@@ -1,4 +1,5 @@
-import { ITeacher } from "./teacher_interface";
+import { ClassInterface } from "./class_interface";
+import { TeacherInterface } from "./teacher_interface";
 
 export class Teacher implements ITeacher {
 
@@ -8,6 +9,8 @@ export class Teacher implements ITeacher {
     first_name: string;     // Teacher's first name
     family_name: string;    // Teacher's family name
     password_hash: string;  // Teacher's hashed password
+    get_classes: () => [ClassInterface];
+    create_class: () => ClassInterface;
 
     // Optional variables
     name_school?: string;   // Teacher's school
@@ -18,12 +21,17 @@ export class Teacher implements ITeacher {
         first_name: string, 
         family_name: string, 
         password_hash: string, 
+        get_classes: () => [ClassInterface],
+        create_class: () => ClassInterface,
         name_school?: string) {
         this.id = id;
         this.email = email;
         this.first_name = first_name;
         this.family_name = family_name;
         this.password_hash = password_hash;
         this.name_school = name_school;
+        this.get_classes = get_classes;
+        this.create_class = create_class;
     }
+    
 }

backend/src/core/entities/teacher_interface.ts

@@ -1,11 +1,9 @@
-export interface ITeacher {
-    // Necessary variables
-    id: string;     // Teacher id
-    email: string;  // Teacher's email
-    first_name: string;     // Teacher's first name
-    family_name: string;    // Teacher's family name
-    password_hash: string;  // Teacher's hashed password
+import { ClassInterface } from "./class_interface";
+import { UserInterface } from "./user_interface";
 
+export interface TeacherInterface extends UserInterface{
     // Optional variables
     name_school?: string;   // Teacher's school
+
+    create_class: () => ClassInterface;
 }

backend/src/core/entities/user_interface.ts

@@ -0,0 +1,11 @@
+import { ClassInterface } from "./class_interface";
+
+export interface UserInterface {
+    // Necessary variables
+    id: string;     // User's id
+    email: string;  // User's email
+    first_name: string;     // User's first name
+    family_name: string;    // User's family name
+    password_hash: string;  // User's hashed password
+    get_classes: () => [ClassInterface];
+}