CourseInstanceCollection

api/course. CourseInstanceCollection

Represents the taking of a course by a specific student in a specific semester.

Constructor

new CourseInstanceCollection()

Source:

Creates the CourseInstance collection.

Extends

Methods

assertAllDefined(names)

Source:
Inherited From:

Verifies that the list of passed instances are all members of this collection.

Parameters:
Name Type Description
names

Should be a list of docs and/or docIDs.

Throws:

If instances is not an array, or if any instance is not in this collection.

Type
Meteor.Error

assertDefined(name)

Source:
Inherited From:

Verifies that the passed object is one of this collection's instances.

Parameters:
Name Type Description
name String | List

Should be a defined ID or doc in this collection.

Throws:

If not defined.

Type
Meteor.Error

assertValidRoleForMethod(userId)

Source:
Overrides:

Implementation of assertValidRoleForMethod. Asserts that userId is logged in as an Admin, Advisor or
Student.
This is used in the define, update, and removeIt Meteor methods associated with each class.

Parameters:
Name Type Description
userId

The userId of the logged in user. Can be null or undefined

Throws:

If there is no logged in user, or the user is not an Admin or Advisor.

Type
Meteor.Error

checkIntegrity() → {Array}

Source:
Overrides:

Returns an array of strings, each one representing an integrity problem with this collection.
Returns an empty array if no problems were found.
Checks semesterID, courseID, and studentID.

Returns:

A (possibly empty) array of strings indicating integrity issues.

Type
Array

count() → {Number}

Source:
Inherited From:

Returns the number of documents in this collection.

Returns:

The number of elements in this collection.

Type
Number

define(description)

Source:

Defines a new CourseInstance.

Example
// To define an instance of a CS course:
CourseInstances.define({ semester: 'Spring-2016',
                         course: 'ics311',
                         verified: false,
                         fromSTAR: false,
                         grade: 'B',
                         note: '',
                         student: 'joesmith@hawaii.edu',
                         creditHrs: 3 });
Parameters:
Name Type Description
description Object

Object with keys semester, course, verified, fromSTAR, grade,
note, student, creditHrs.
Required fields: semester, student, course, which must all be valid slugs or instance IDs.
If the course slug is 'other', then the note field will be used as the course number.
Optional fields: note (defaults to ''), valid (defaults to false), grade (defaults to '').
CreditHrs defaults to the creditHrs assigned to course, or can be provided explicitly.

Throws:

If the definition includes an undefined course or student.

Type
Meteor.Error
Returns:

The newly created docID.

dumpAll() → {Object}

Source:
Inherited From:

Returns an object with two fields: name and contents.
Name is the name of this collection.
Contents is an array of objects suitable for passing to the restore() method.

Returns:

An object representing the contents of this collection.

Type
Object

dumpOne(docID) → {Object}

Source:
Overrides:

Returns an object representing the CourseInstance docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of a CourseInstance.

Returns:

An object representing the definition of docID.

Type
Object

find(selector, options) → {Mongo.Cursor}

Source:
Inherited From:
See:

Runs find on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

findCourseInstanceDoc(semester, course, student) → {Object}

Source:

Returns the courseInstance document associated with semester, course, and student.

Parameters:
Name Type Description
semester

The semester (slug or ID).

course

The course (slug or ID).

student

The student (slug or ID)

Throws:

If semester, course, or student does not exist.

Type
Meteor.Error
Returns:

Returns the document or null if not found.

Type
Object

findCourseName(courseInstanceID) → {String}

Source:
Parameters:
Name Type Description
courseInstanceID

The course instance ID.

Throws:

If courseInstanceID is not a valid ID.

Type
Meteor.Error
Returns:

The course name associated with courseInstanceID.

Type
String

findDoc(name) → {Object}

Source:
Inherited From:

A stricter form of findOne, in that it throws an exception if the entity isn't found in the collection.

Parameters:
Name Type Description
name String | Object

Either the docID, or an object selector, or the 'name' field value.

Throws:

If the document cannot be found.

Type
Meteor.Error
Returns:

The document associated with name.

Type
Object

findOne(selector, options) → {Mongo.Cursor}

Source:
Inherited From:
See:

Runs findOne on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

getCollectionName() → {string}

Source:
Inherited From:

Returns the collection name.

Returns:

The collection name as a string.

Type
string

getCourseDoc(instanceID) → {Object}

Source:

Returns the Course associated with the CourseInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

Throws:

If instanceID is not a valid ID.

Type
Meteor.Error
Returns:

The associated Course.

Type
Object

getCourseSlug(instanceID) → {string}

Source:

Returns the Course slug for the instance's corresponding Course.

Parameters:
Name Type Description
instanceID

The CourseInstanceID.

Returns:

The course slug.

Type
string

getPublicationName() → {String}

Source:
Inherited From:

Return the publication name.

Returns:

The publication name, as a string.

Type
String

getSemesterDoc(instanceID) → {Object}

Source:

Returns the Semester associated with the CourseInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

Throws:

If instanceID is not a valid ID.

Type
Meteor.Error
Returns:

The associated Semester.

Type
Object

getStudentDoc(instanceID) → {Object}

Source:

Returns the Student profile associated with the CourseInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

Throws:

If instanceID is not a valid ID.

Type
Meteor.Error
Returns:

The associated Student profile.

Type
Object

getType() → {String}

Source:
Inherited From:

Return the type of this collection.

Returns:

The type, as a string.

Type
String

isCourseInstance(semester, course, student)

Source:

Returns true if there exists a CourseInstance for the given semester, course, and student.

Parameters:
Name Type Description
semester

The semester (slug or ID).

course

The course (slug or ID).

student

The student (slug or ID).

Throws:

If semester, course, or student does not exist.

Type
Meteor.Error
Returns:

True if the course instance exists.

isDefined(name) → {boolean}

Source:
Inherited From:

Returns true if the passed entity is in this collection.

Parameters:
Name Type Description
name String | Object

The docID, or an object specifying a documennt.

Returns:

True if name exists in this collection.

Type
boolean

isInteresting(courseInstanceID) → {boolean}

Source:
Parameters:
Name Type Description
courseInstanceID

The course instance ID.

Throws:

If courseInstanceID is not a valid ID.

Type
Meteor.Error
Returns:

If the course is an interesting course associated with courseInstanceID.

Type
boolean

publish()

Source:
Overrides:

Depending on the logged in user publish only their CourseInstances. If
the user is in the Role.ADMIN then publish all CourseInstances.

removeAll()

Source:
Inherited From:

Removes all elements of this collection.
This is implemented by mapping through all elements because mini-mongo does not implement the remove operation.
So this approach can be used on both client and server side.
removeAll should only used for testing purposes, so it doesn't need to be efficient.

Returns:

true

removeIt(docID)

Source:
Overrides:

Remove the course instance.

Parameters:
Name Type Description
docID

The docID of the course instance.

removeUser(user)

Source:

Removes all CourseInstance documents referring to user.

Parameters:
Name Type Description
user

The user, either the ID or the username.

Throws:

If user is not an ID or username.

Type
Meteor.Error

restoreAll(dumpObjects)

Source:
Inherited From:

Defines all the entities in the passed array of objects.

Parameters:
Name Type Description
dumpObjects

The array of objects representing the definition of a document in this collection.

restoreOne(dumpObject) → {String}

Source:
Inherited From:

Defines the entity represented by dumpObject.
Defaults to calling the define() method if it exists.

Parameters:
Name Type Description
dumpObject

An object representing one document in this collection.

Returns:

The docID of the newly created document.

Type
String

subscribe()

Source:
Inherited From:

Default subscription method for entities.
It subscribes to the entire collection.

toString(courseInstanceID) → {String}

Source:
Overrides:
Parameters:
Name Type Description
courseInstanceID

The course instance ID.

Throws:

If not a valid ID.

Type
Meteor.Error
Returns:

A formatted string representing the course instance.

Type
String

update(docID, semesterID, verified, fromSTAR, grade, creditHrs, note, ice)

Source:
Overrides:

Update the course instance. Only a subset of fields can be updated.

Parameters:
Name Type Description
docID

The course instance docID (required).

semesterID

the semesterID for the course instance optional.

verified

boolean optional.

fromSTAR

boolean optional.

grade

optional.

creditHrs

optional.

note

optional.

ice

an object with fields i, c, e (optional)

updateGrade(courseInstanceID, grade)

Source:

Updates the CourseInstance's grade. This should be used for planning purposes.

Parameters:
Name Type Description
courseInstanceID

The course instance ID.

grade

The new grade.

Throws:

If courseInstanceID is not a valid ID.

Type
Meteor.Error

updateSemester(courseInstanceID, semesterID)

Source:

Updates the CourseInstance's Semester.

Parameters:
Name Type Description
courseInstanceID

The course instance ID.

semesterID

The semester id.

Throws:

If courseInstanceID is not a valid ID.

Type
Meteor.Error