api/degree-plan

api/degree-plan

Classes

AcademicPlanCollection
AcademicYearInstanceCollection
DesiredDegreeCollection
PlanChoiceCollection
PreferredChoice

Members

(static, constant) exports.AcademicPlans

Source:

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

(static, constant) exports.AcademicYearInstances

Source:

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

(static, constant) exports.DesiredDegrees

Source:

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

(static, constant) exports.PlanChoices

Source:

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

Methods

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

Source:

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

Parameters:
Name Type Description
slug

the course slug.

Returns:
Type
string

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

Source:

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

Parameters:
Name Type Description
slug

the simple plan choice.

Returns:
Type
string

(static) exports.complexChoiceToArray(planChoice)

Source:

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.

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

Source:

Returns the department from a course slug.

Parameters:
Name Type Description
courseSlug
Returns:
Type
*

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

Source:

Returns an array of the departments in the plan choice.

Parameters:
Name Type Description
planChoice

The plan choice.

Returns:
Type
Array

(static) exports.getStudentsCurrentSemesterNumber(studentID) → {number}

Source:

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

Parameters:
Name Type Description
studentID

the studentID.

Returns:
Type
number

(static) exports.getStudentSemesters(studentID)

Source:

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

Parameters:
Name Type Description
studentID

the studentID.

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

Source:

Returns true if the plan choice includes a sub-choice (e.g. '(ics313,ics331),ics355-1' )

Parameters:
Name Type Description
planChoice

the plan choice.

Returns:
Type
boolean

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

Source:

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

Parameters:
Name Type Description
planChoice

the plan choice.

Returns:
Type
boolean

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

Source:

Returns true if the planChoice is a single choice.

Parameters:
Name Type Description
planChoice

the plan choice.

Returns:
Type
boolean

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

Source:

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

Parameters:
Name Type Description
planChoice

the plan choice.

Returns:
Type
boolean

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

Source:

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

Parameters:
Name Type Description
planChoices

an array of plan choices.

courseSlug

the course slug.

Returns:

the index of courseSlug in the array.

Type
Number

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

Source:

Returns true if the courseSlug satisfies the plan choice.

Parameters:
Name Type Description
planChoice

The plan choice.

courseSlug

The course slug.

Returns:
Type
Boolean

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

Source:

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 ics400+ in the B.S. degree).

Parameters:
Name Type Description
planChoice

the plan choice.

Returns:
Type
*

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

Source:

Returns true if the courseSlug satisfies the planChoice.

Parameters:
Name Type Description
planChoice

a plan choice.

courseSlug

a course's slug.

Returns:
Type
*