Old GraduateNU Definitions

gistfile1.ts

/**
* Represents an initial schedule representation as crafted via the degree audit.
* @param completed - The completed courses and NUPaths.
* @param inprogress - The in-progress courses and NUPaths.
* @param requirements - The requirements for courses and NUPaths yet to be satisfied.
* @param data - Supplemental information about the student's academic path.
* @param majors - The major(s) the student intends to obtain degrees for.
* @param minors - The minor(s) the student intends to obtain.
* @param auditYear - The year the degree audit was created.
* @param gradDate - The expected graduation date of the student.
* @param nupaths - The NUPaths required or satisfied.
* @param courses - The courses required or satisfied.
*/
export interface IInitialScheduleRep {
  completed: {
    nupaths: NUPath[];
    courses: ICompleteCourse[];
  };
  inprogress: {
    courses: ICompleteCourse[];
    nupaths: NUPath[];
  };
  requirements: {
    courses: IOldRequirement[];
    nupaths: NUPath[];
  };

  data: {
    majors: string[];
    minors: string[];
    auditYear: number;
    gradDate: Date;
  };
}


/**
* Describes a completed Course with all of the course information provided by the Northeastern degree audit.
* @param hon - True if this course is Honors, false otherwise.
* @param subject - The subject of this course (such as Computer Science - "CS" - or Psychology)
* @param classId - The number used to identify the course along with the subject.
* @param name - The unique name of this course.
* @param creditHours - The number of credit hours this course is worth.
* @param season - The season during which this course was taken.
* @param year - The year during which this course was taken.
* @param termId - Northeastern's identifier for the term during which this course was taken.
*/
export interface ICompleteCourse {
  hon: boolean;
  subject: string;
  classId: number;
  name: string;
  creditHours: number;
  season: Season;
  year: number;
  termId: number;
}


/**
* Represents one of the seasons in which a student can take a course, as abbreviated by Northeastern.
*/
export enum SeasonEnum {
  FL = "FL",
  SP = "SP",
  S1 = "S1",
  S2 = "S2",
  SM = "SM",
}