Namespace

api/degree-plan

api/degree-plan

Classes

AcademicPlanCollection
AcademicYearInstanceCollection
exports.PlanChoiceCollection
PreferredChoice

Members

# static constant exports.AcademicPlans

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

View Source api/degree-plan/AcademicPlanCollection.ts, line 284

# static constant exports.AcademicYearInstances

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

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

# static constant exports.PlanChoices

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

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

Methods

# static exports.buildCourseSlugName(slug) → {string}

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

Parameters:
Name Type Description
slug

the course slug.

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

string

# static exports.buildSimpleName(slug) → {string}

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

Parameters:
Name Type Description
slug

the simple plan choice.

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

string

# static exports.complexChoiceToArray(planChoice)

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.

Parameters:
Name Type Description
planChoice

a plan choice.

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

# static exports.getDepartment(courseSlug) → {*}

Returns the department from a course slug.

Parameters:
Name Type Description
courseSlug

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

*

# static exports.getDepartments(planChoice) → {Array}

Returns an array of the departments in the plan choice.

Parameters:
Name Type Description
planChoice

The plan choice.

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

Array

# static exports.getStudentsCurrentAcademicTermNumber(studentID) → {number}

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

Parameters:
Name Type Description
studentID

the studentID.

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

number

# static exports.getStudentTerms(studentID)

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

Parameters:
Name Type Description
studentID

the studentID.

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

# static exports.isComplexChoice(planChoice) → {boolean}

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

Parameters:
Name Type Description
planChoice

the plan choice.

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

boolean

# static exports.isSimpleChoice(planChoice) → {boolean}

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

Parameters:
Name Type Description
planChoice

the plan choice.

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

boolean

# static exports.isSingleChoice(planChoice) → {boolean}

Returns true if the planChoice is a single choice.

Parameters:
Name Type Description
planChoice

the plan choice.

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

boolean

# static exports.isXXChoice(planChoice) → {boolean}

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

Parameters:
Name Type Description
planChoice

the plan choice.

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

boolean

# static exports.planIndexOf(planChoices, courseSlug) → {Number}

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

Parameters:
Name Type Description
planChoices

an array of plan choices.

courseSlug

the course slug.

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

the index of getCourseSlug in the array.

Number

# static exports.satisfiesPlanChoice(planChoice, courseSlug) → {Boolean}

Returns true if the courseSlug satisfies the plan choice.

Parameters:
Name Type Description
planChoice

The plan choice.

courseSlug

The course slug.

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

Boolean

# static exports.stripCounter(planChoice) → {*}

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).

Parameters:
Name Type Description
planChoice

the plan choice.

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

*

# 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

*