Gradebook Frontend Documentation - v0.0.0
    Preparing search index...

    Service responsible for managing course-related operations in the frontend. Handles communication with the backend for course creation, student enrollment, grade management, and course information retrieval.

    Index

    Constructors

    Methods

    • Adds a grade for a specific student in a course.

      Parameters

      • courseId: number

        The ID of the course

      • studentEmail: string

        The email of the student receiving the grade

      • grade: number

        The numeric grade value

      Returns Promise<CourseGrade>

      A Promise resolving with the created grade object or rejecting with an error message

    • Creates a new course in the system.

      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<any>

      A Promise resolving with the created course or rejecting with an error message

    • Deletes a grade for a student.

      Parameters

      • id: number

        The ID of the grade to delete

      Returns Promise<boolean>

      A Promise resolving with a boolean success indicator or rejecting with an error message

    • Deletes a course from the system.

      Parameters

      • title: string

        The title of the course to delete

      • teacherEmail: string

        The email of the teacher attempting to delete the course

      Returns Promise<any>

      A Promise resolving with a success message or rejecting with an error message

    • Edits an existing grade for a student.

      Parameters

      • id: number

        The ID of the grade to edit

      • grade: number

        The new grade value

      Returns Promise<boolean>

      A Promise resolving with a boolean success indicator or rejecting with an error message

    • Enrolls a student in a 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<any>

      A Promise resolving with a success message or rejecting with an error message

    • Retrieves all courses in which a specific student is enrolled.

      Parameters

      • studentEmail: string

        The email of the student

      Returns Promise<any>

      A Promise resolving with an array of course information objects or rejecting with an error message

    • Retrieves all courses taught by a specific teacher.

      Parameters

      • teacherEmail: string

        The email of the teacher

      Returns Promise<any>

      A Promise resolving with an array of course information objects or rejecting with an error message

    • Retrieves detailed information about a specific course.

      Parameters

      • id: number

        The ID of the course to retrieve

      Returns Promise<CoursePageInfo>

      A Promise resolving with course details or rejecting with an error message

    • Retrieves the list of students enrolled in a specific course.

      Parameters

      • courseTitle: string

        The title of the course

      Returns Promise<any>

      A Promise resolving with an array of student information objects or rejecting with an error message

    • Submits multiple grades for students in a course at once.

      Parameters

      • courseId: number

        The ID of the course

      • gradesArray: { email: string; grade: number }[]

        Array of objects containing student emails and their grades

      Returns Promise<any>

      A Promise resolving with a success message or rejecting with an error message