Class CourseService

Service responsible for managing course-related operations in the gradebook system. Handles course creation, student enrollment, grade management, and course information retrieval.

Index

Constructors

constructor

Methods

addStudentGrade createCourse deleteStudentGrade destroyCourse editStudentGrade enrollStudent findByTitle findCoursesByStudent findCoursesByTeacher getCourse getStudentsForCourse submitGradesForCourse

Constructors

constructor

new CourseService(
    courseRepo: Repository<Course>,
    studentCourseGradeRepo: Repository<StudentCourseGrade>,
    userService: UserService,
    studentCourseService: StudentCourseService,
    gradeHistoryService: GradeHistoryService,
): CourseService
Creates an instance of CourseService.
Parameters
- courseRepo: Repository<Course>
  Repository for Course entities
- studentCourseGradeRepo: Repository<StudentCourseGrade>
  Repository for StudentCourseGrade entities
- userService: UserService
  Service for user-related operations
- studentCourseService: StudentCourseService
  Service for student-course relationship operations
- gradeHistoryService: GradeHistoryService
  Service for tracking grade history changes
Returns CourseService
- Defined in course/course.service.ts:29

Methods

addStudentGrade

addStudentGrade(
    courseId: number,
    studentEmail: string,
    grade: number,
    teacher: User,
): Promise<{ date: Date; grade: number; id: number }>
Adds a grade for a specific student in a course. Only the teacher of the course can add grades.
Parameters
- courseId: number
  The ID of the course
- studentEmail: string
  The email of the student receiving the grade
- grade: number
  The numeric grade value
- teacher: User
  The teacher adding the grade
Returns Promise<{ date: Date; grade: number; id: number }>
The newly created grade object

Throws
NotFoundException if the course or student is not found

Throws
BadRequestException if the teacher is not authorized to add grades
- Defined in course/course.service.ts:289

createCourse

createCourse(
    title: string,
    description: string,
    teacherEmail: string,
): Promise<Course>
Creates a new course with the specified teacher as the owner.
Parameters
- title: string
  The title of the course
- description: string
  The description of the course
- teacherEmail: string
  The email of the teacher creating the course
Returns Promise<Course>
The newly created course entity

Throws
NotFoundException if the teacher is not found

Throws
BadRequestException if a course with the same title already exists
- Defined in course/course.service.ts:47

deleteStudentGrade

deleteStudentGrade(gradeId: number, teacher: User): Promise<boolean>
Marks a grade as deleted (soft delete). Only the teacher of the course can delete grades. The deletion is recorded in grade history.
Parameters
- gradeId: number
  The ID of the grade to delete
- teacher: User
  The teacher deleting the grade
Returns Promise<boolean>
True if the grade was successfully marked as deleted

Throws
NotFoundException if the grade is not found

Throws
BadRequestException if the teacher is not authorized to delete the grade
- Defined in course/course.service.ts:392

destroyCourse

destroyCourse(title: string, teacherEmail: string): Promise<{ message: string }>
Deletes a course from the system. Only the teacher who created the course is authorized to delete it.
Parameters
- title: string
  The title of the course to delete
- teacherEmail: string
  The email of the teacher attempting to delete the course
Returns Promise<{ message: string }>
A success message upon successful deletion

Throws
NotFoundException if the course is not found

Throws
BadRequestException if the user is not authorized to delete the course
- Defined in course/course.service.ts:76

editStudentGrade

editStudentGrade(
    gradeId: number,
    grade: number,
    teacher: User,
): Promise<boolean>
Edits an existing grade for a student. Only the teacher of the course can edit grades. The change is recorded in grade history.
Parameters
- gradeId: number
  The ID of the grade to edit
- grade: number
  The new grade value
- teacher: User
  The teacher editing the grade
Returns Promise<boolean>
True if the grade was successfully updated

Throws
NotFoundException if the grade is not found

Throws
BadRequestException if the teacher is not authorized to edit the grade
- Defined in course/course.service.ts:350

enrollStudent

enrollStudent(
    courseTitle: string,
    studentEmail: string,
    teacherEmail: string,
): Promise<{ message: string }>
Enrolls a student in a specific course.
Parameters
- courseTitle: string
  The title of the course
- studentEmail: string
  The email of the student to enroll
- teacherEmail: string
  The email of the teacher authorizing the enrollment
Returns Promise<{ message: string }>
The result of the enrollment operation

Throws
NotFoundException if the course is not found
- Defined in course/course.service.ts:117

findByTitle

findByTitle(title: string): Promise<null | Course>
Finds a course by its title, including related teacher and student information.
Parameters
- title: string
  The title of the course to find
Returns Promise<null | Course>
The course entity if found, otherwise null
- Defined in course/course.service.ts:100

findCoursesByStudent

findCoursesByStudent(
    studentEmail: string,
): Promise<
    {
        description: string;
        grades: { date: Date; grade: number; id: number }[];
        id: number;
        students: StudentCourse[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
Retrieves all courses in which a specific student is enrolled.
Parameters
- studentEmail: string
  The email of the student
Returns Promise<
    {
        description: string;
        grades: { date: Date; grade: number; id: number }[];
        id: number;
        students: StudentCourse[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
An array of course information objects
- Defined in course/course.service.ts:175

findCoursesByTeacher

findCoursesByTeacher(
    teacherEmail: string,
): Promise<
    {
        description: string;
        id: number;
        students: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
Retrieves all courses taught by a specific teacher.
Parameters
- teacherEmail: string
  The email of the teacher
Returns Promise<
    {
        description: string;
        id: number;
        students: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
An array of course information objects

Throws
NotFoundException if the teacher is not found
- Defined in course/course.service.ts:134

getCourse

getCourse(
    id: number,
    user: User,
): Promise<
    {
        description: string;
        grades: undefined
        | StudentCourseGrade[];
        id: number;
        students:
            | undefined
            | {
                email: string;
                firstName: string;
                grades: { date: Date; grade: number; id: number }[];
                image: string;
                lastName: string;
                role: UserRole;
            }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    },
>
Retrieves detailed information about a specific course, with access control based on user role. Teachers see all student information and grades, while students only see their own grades.
Parameters
- id: number
  The ID of the course to retrieve
- user: User
  The user requesting the course information
Returns Promise<
    {
        description: string;
        grades: undefined
        | StudentCourseGrade[];
        id: number;
        students:
            | undefined
            | {
                email: string;
                firstName: string;
                grades: { date: Date; grade: number; id: number }[];
                image: string;
                lastName: string;
                role: UserRole;
            }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    },
>
Course details including teacher info and conditionally student info and grades

Throws
NotFoundException if the course is not found

Throws
BadRequestException if the user is not authorized to view the course
- Defined in course/course.service.ts:224

getStudentsForCourse

getStudentsForCourse(
    courseTitle: string,
): Promise<
    {
        email: string;
        firstName: string;
        image: string;
        lastName: string;
        role: UserRole;
    }[],
>
Retrieves the list of students enrolled in a specific course.
Parameters
- courseTitle: string
  The title of the course
Returns Promise<
    {
        email: string;
        firstName: string;
        image: string;
        lastName: string;
        role: UserRole;
    }[],
>
An array of student information objects

Throws
NotFoundException if the course is not found
- Defined in course/course.service.ts:189

submitGradesForCourse

submitGradesForCourse(
    courseId: number,
    gradesArray: { email: string; grade: number }[],
    teacher: User,
): Promise<{ message: string }>
Submits multiple grades for students in a course at once. Only the teacher of the course can submit grades.
Parameters
- courseId: number
  The ID of the course
- gradesArray: { email: string; grade: number }[]
  Array of objects containing student emails and their grades
- teacher: User
  The teacher submitting the grades
Returns Promise<{ message: string }>
A success message upon successful submission

Throws
NotFoundException if the course or a student is not found

Throws
BadRequestException if the teacher is not authorized to submit grades
- Defined in course/course.service.ts:434

Class CourseService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CourseService

Methods

addStudentGrade

Parameters

Returns Promise<{ date: Date; grade: number; id: number }>

Throws

Throws

createCourse

Parameters

Returns Promise<Course>

Throws

Throws

deleteStudentGrade

Parameters

Returns Promise<boolean>

Throws

Throws

destroyCourse

Parameters

Returns Promise<{ message: string }>

Throws

Throws

editStudentGrade

Parameters

Returns Promise<boolean>

Throws

Throws

enrollStudent

Parameters

Returns Promise<{ message: string }>

Throws

findByTitle

Parameters

Returns Promise<null | Course>

findCoursesByStudent

Parameters

Returns Promise< { description: string; grades: { date: Date; grade: number; id: number }[]; id: number; students: StudentCourse[]; teacher: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }; title: string; }[],>

findCoursesByTeacher

Parameters

Returns Promise< { description: string; id: number; students: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }[]; teacher: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }; title: string; }[],>

Throws

getCourse

Parameters

Throws

Throws

getStudentsForCourse

Parameters

Returns Promise< { email: string; firstName: string; image: string; lastName: string; role: UserRole; }[],>

Throws

submitGradesForCourse

Parameters

Returns Promise<{ message: string }>

Throws

Throws

Settings

On This Page

Returns Promise<
{
description: string;
grades: { date: Date; grade: number; id: number }[];
id: number;
students: StudentCourse[];
teacher: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
};
title: string;
}[],
>

Returns Promise<
{
description: string;
id: number;
students: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
}[];
teacher: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
};
title: string;
}[],
>

Returns Promise<
{
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
}[],
>