API Documentation

Class

CourseInstanceCollection

api/course.CourseInstanceCollection()

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

Constructor

# new CourseInstanceCollection()

Creates the CourseInstance collection.

View Source api/course/CourseInstanceCollection.ts, line 32

Extends

Methods

# assertAllDefined(names)

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.
Overrides:

View Source api/base/BaseCollection.ts, line 268

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

Meteor.Error

# assertDefined(name)

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.
Overrides:

View Source api/base/BaseCollection.ts, line 258

If not defined.

Meteor.Error

# assertValidRoleForMethod(userId)

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
Overrides:

View Source api/course/CourseInstanceCollection.ts, line 222

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

Meteor.Error

# checkIntegrity() → {Array}

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

Overrides:

View Source api/course/CourseInstanceCollection.ts, line 415

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

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 71

The number of elements in this collection.

Number

# countNonRetired() → {Number}

Returns the number of non-retired documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 78

The number of non-retired elements in this collection.

Number

# define(description)

Defines a new CourseInstance.

Parameters:
Name Type Description
description Object

Object with keys academicTerm, course, verified, fromRegistrar, grade, note, student, creditHrs. Required fields: academicTerm, 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.
Overrides:

View Source api/course/CourseInstanceCollection.ts, line 103

If the definition includes an undefined course or student.

Meteor.Error

The newly created docID.

Example
// To define an instance of a CS course:
CourseInstances.define({ academicTerm: 'Spring-2016',
                         course: 'ics_311',
                         verified: false,
                         fromRegistrar: false,
                         grade: 'B',
                         note: '',
                         student: 'joesmith@hawaii.edu',
                         creditHrs: 3 });

# dumpAll() → {Object}

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.

Overrides:

View Source api/base/BaseCollection.ts, line 297

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

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

Parameters:
Name Type Description
docID

The docID of a CourseInstance.
Overrides:

View Source api/course/CourseInstanceCollection.ts, line 435

An object representing the definition of docID.

Object

# dumpUser(usernameOrID) → {Array.<CourseInstanceDefine>}

Dumps the CourseInstances for the given usernameOrID.

Parameters:
Name Type Description
usernameOrID string

View Source api/course/CourseInstanceCollection.ts, line 453

Array.<CourseInstanceDefine>

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

Runs find on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.
options Object

MongoDB options.
Overrides:
See:

View Source api/base/BaseCollection.ts, line 132

Mongo.Cursor

# findCourseInstanceDoc(academicTerm, course, student) → {Object}

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

Parameters:
Name Type Description
academicTerm

The academicTerm (slug or ID).
course

The course (slug or ID).
student

The student (slug or ID)

View Source api/course/CourseInstanceCollection.ts, line 316

If academicTerm, course, or student does not exist.

Meteor.Error

Returns the document or null if not found.

Object

# findCourseName(courseInstanceID) → {String}

Parameters:
Name Type Description
courseInstanceID

The course instance ID.

View Source api/course/CourseInstanceCollection.ts, line 303

If courseInstanceID is not a valid ID.

Meteor.Error

The course name associated with courseInstanceID.

String

# findDoc(name) → {Object}

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.
Overrides:

View Source api/base/BaseCollection.ts, line 107

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# findNonRetired(selector, options) → {Array}

Runs find on this collection and returns the non-retired documents.

Parameters:
Name Type Description
selector Object

A MongoDB selector.
options Object

MongoDB options.
Overrides:
See:

View Source api/base/BaseCollection.ts, line 143

non-retired documents.

Array

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

Runs findOne on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.
options Object

MongoDB options.
Overrides:
See:

View Source api/base/BaseCollection.ts, line 154

Mongo.Cursor

# getAcademicTermDoc(instanceID) → {Object}

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

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

View Source api/course/CourseInstanceCollection.ts, line 259

If instanceID is not a valid ID.

Meteor.Error

The associated AcademicTerm.

Object

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

View Source api/base/BaseCollection.ts, line 243

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

View Source api/base/BaseCollection.ts, line 236

The collection name as a string.

string

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

View Source api/base/BaseCollection.ts, line 208

.

SimpleSchema

# getCourseDoc(instanceID) → {Object}

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

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

View Source api/course/CourseInstanceCollection.ts, line 231

If instanceID is not a valid ID.

Meteor.Error

The associated Course.

Object

# getCourseSlug(instanceID) → {string}

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

Parameters:
Name Type Description
instanceID

The CourseInstanceID.

View Source api/course/CourseInstanceCollection.ts, line 241

The course slug.

string

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 215

the define method's parameter.

SimpleSchema

# getPublicationName() → {String}

Return the publication name.

Overrides:

View Source api/base/BaseCollection.ts, line 229

The publication name, as a string.

String

# getPublicationNames() → {Object}

Gets the publication names.

View Source api/course/CourseInstanceCollection.ts, line 250

the publication names.

Object

# getStudentDoc(instanceID) → {Object}

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

Parameters:
Name Type Description
instanceID

The id of the CourseInstance.

View Source api/course/CourseInstanceCollection.ts, line 293

If instanceID is not a valid ID.

Meteor.Error

The associated Student profile.

Object

# getType() → {String}

Return the type of this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 201

The type, as a string.

String

# getUpdateSchema() → {SimpleSchema}

Returns a schema for the update method's second parameter.

Overrides:

View Source api/course/CourseInstanceCollection.ts, line 268

.

SimpleSchema

# isCourseInstance(academicTerm, course, student)

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

Parameters:
Name Type Description
academicTerm

The academicTerm (slug or ID).
course

The course (slug or ID).
student

The student (slug or ID).

View Source api/course/CourseInstanceCollection.ts, line 330

If academicTerm, course, or student does not exist.

Meteor.Error

True if the course instance exists.

# isDefined(name) → {boolean}

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.
Overrides:

View Source api/base/BaseCollection.ts, line 163

True if name exists in this collection.

boolean

# isInCurrentOrPast(courseInstanceID) → {boolean}

Returns true if the CourseInstance is in the current term or past.

Parameters:
Name Type Description
courseInstanceID string

The id to check.

View Source api/course/CourseInstanceCollection.ts, line 348

true if the course instance is in the current term or the past.

boolean

# isInteresting(courseInstanceID) → {boolean}

Parameters:
Name Type Description
courseInstanceID

The course instance ID.

View Source api/course/CourseInstanceCollection.ts, line 338

If courseInstanceID is not a valid ID.

Meteor.Error

If the course is an interesting course associated with courseInstanceID.

boolean

# publish()

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

Overrides:

View Source api/course/CourseInstanceCollection.ts, line 358

# removeAll()

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.

Overrides:

View Source api/base/BaseCollection.ts, line 190

true

# removeIt(docID)

Remove the course instance.

Parameters:
Name Type Description
docID

The docID of the course instance.
Overrides:

View Source api/course/CourseInstanceCollection.ts, line 201

# removeUser(user)

Removes all CourseInstance documents referring to user.

Parameters:
Name Type Description
user

The user, either the ID or the username.

View Source api/course/CourseInstanceCollection.ts, line 211

If user is not an ID or username.

Meteor.Error

# restoreAll(dumpObjects)

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.
Overrides:

View Source api/base/BaseCollection.ts, line 335

# restoreOne(dumpObject) → {String}

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.
Overrides:

View Source api/base/BaseCollection.ts, line 325

The docID of the newly created document.

String

# subscribe()

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

Overrides:

View Source api/base/BaseCollection.ts, line 94

# toString(courseInstanceID) → {string}

Parameters:
Name Type Description
courseInstanceID

The course instance ID.
Overrides:

View Source api/course/CourseInstanceCollection.ts, line 379

If not a valid ID.

Meteor.Error

A formatted string representing the course instance.

string

# update(docID, termID, verified, fromRegistrar, grade, creditHrs, note, ice)

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

Parameters:
Name Type Description
docID

The course instance docID (required).
termID

the termID for the course instance optional.
verified

boolean optional.
fromRegistrar

boolean optional.
grade

optional.
creditHrs

optional.
note

optional.
ice

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

View Source api/course/CourseInstanceCollection.ts, line 164

# updateAcademicTerm(courseInstanceID, termID)

Updates the CourseInstance's AcademicTerm.

Parameters:
Name Type Description
courseInstanceID

The course instance ID.
termID

The academicTerm id.

View Source api/course/CourseInstanceCollection.ts, line 404

If courseInstanceID is not a valid ID.

Meteor.Error

# updateGrade(courseInstanceID, grade)

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.

View Source api/course/CourseInstanceCollection.ts, line 393

If courseInstanceID is not a valid ID.

Meteor.Error