Namespace

api/degree-plan

api/degree-plan

Classes

AcademicYearInstanceCollection
exports.PlanChoiceCollection
PreferredChoice

Members

# static constant exports.AcademicYearInstances

Provides the singleton instance of this class to all other entities.

View Source api/degree-plan/AcademicYearInstanceCollection.ts, line 232

# static constant exports.buildCourseSlugName

Creates the course name from the slug. Course names have department in all caps.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 98

# static constant exports.buildSimpleName

Builds the Name for a simple planChoice. Will have commas replaced by ' or '.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 108

# static constant exports.complexChoiceToArray

Converts a complex choice into an array of the slugs that make up the choice. Note: This may not be enough to solve the generate plan problem.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 79

# static constant exports.getDepartment

Returns the department from a course slug.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 122

# static constant exports.getDepartments

Returns an array of the departments in the plan choice.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 136

# static constant exports.getStudentsCurrentAcademicTermNumber

Returns the student's current academicTerm number (i.e. which academicTerm are they currently in.)

View Source api/degree-plan/AcademicYearUtilities.ts, line 12

# static constant exports.getStudentTerms

Returns an array of the academicTermIDs that the student has taken or is planning to take courses or opportunities in.

View Source api/degree-plan/AcademicYearUtilities.ts, line 33

# static constant exports.isComplexChoice

Returns true if the plan choice includes a sub-choice (e.g. '(ics_313,ics_331),ics_355-1' )

View Source api/degree-plan/PlanChoiceUtilities.ts, line 57

# static constant exports.isSimpleChoice

Returns true if the plan choice is a simple choice, just individual slugs separated by commas.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 45

# static constant exports.isSingleChoice

Returns true if the planChoice is a single choice.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 35

# static constant exports.isXXChoice

Returns true if the planChoice is a 300+ or 400+.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 69

# static constant exports.PlanChoices

Provides the singleton instance of this class to all other entities.

View Source api/degree-plan/PlanChoiceCollection.ts, line 189

# static constant exports.planIndexOf

Returns the index of the getCourseSlug in the array of plan choices.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 196

# static constant exports.satisfiesPlanChoice

Returns true if the courseSlug satisfies the plan choice.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 178

# static constant exports.stripCounter

Strips of the counter for the plan choice. The counter is used in academic plans to keep track of how many choices there are (e.g. five ics_400+ in the B.S. degree).

View Source api/degree-plan/PlanChoiceUtilities.ts, line 10

Methods

# static satisfiesSinglePlanChoice(planChoice, courseSlug) → {*}

Returns true if the getCourseSlug satisfies the planChoice.

Parameters:
Name Type Description
planChoice

a plan choice.

courseSlug

a course's slug.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 154

*