Class

AcademicYearInstanceCollection

api/degree-plan.AcademicYearInstanceCollection()

Each AcademicYearInstance represents a sequence of three or four academic terms for a given student. It is used to control the display of academic terms for a given student in the Degree Planner.

Constructor

# new AcademicYearInstanceCollection()

Creates the AcademicYearInstance collection.

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

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 278

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 268

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/degree-plan/AcademicYearInstanceCollection.ts, line 163

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 studentID, termIDs

Overrides:

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

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 70

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 77

The number of non-retired elements in this collection.

Number

# define(Object)

Defines a new AcademicYearInstance.

Parameters:
Name Type Description
Object Object

with keys year and student.

Overrides:

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

If the definition includes an undefined student or a year that is out of bounds.

Meteor.Error

The newly created docID.

Example
To define the 2016 - 2017 academic year for Joe Smith.
    AcademicYearInstances.define({ year: 2016,
                                   student: 'joesmith' });

# 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 307

An object representing the contents of this collection.

Object

# dumpOne(docID) → {object}

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

Parameters:
Name Type Description
docID

The docID of an AcademicYearInstance.

Overrides:

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

An object representing the definition of docID.

object

# 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 131

Mongo.Cursor

# 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 106

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 142

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 153

Mongo.Cursor

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

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

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

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

The collection name as a string.

string

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

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

.

SimpleSchema

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

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

the define method's parameter.

SimpleSchema

# getPublicationName() → {String}

Return the publication name.

Overrides:

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

The publication name, as a string.

String

# getType() → {String}

Return the type of this collection.

Overrides:

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

The type, as a string.

String

# getUpdateSchema() → {SimpleSchema}

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

Overrides:

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

.

SimpleSchema

# 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 174

True if name exists in this collection.

boolean

# publish()

Depending on the logged in user publish only their AcademicYears. If the user is an Admin or Advisor then publish all AcademicYears.

Overrides:

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

# 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 200

true

# removeIt(docID)

Remove the academic year.

Parameters:
Name Type Description
docID

The docID of the academic year.

Overrides:

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

# removeUser(user)

Removes all AcademicYearInstance documents referring to user.

Parameters:
Name Type Description
user

The student, either the ID or the username.

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

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 345

# 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 335

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 93

# toString(academicYearInstanceID) → {String}

Parameters:
Name Type Description
academicYearInstanceID

The academic year instance ID.

Overrides:

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

If not a valid ID.

Meteor.Error

A formatted string representing the academic year instance.

String

# update(docID, year, springYear, studentID, termIDs)

Update an AcademicYear.

Parameters:
Name Type Description
docID

The docID associated with this academic year.

year

the fall year.

springYear

the spring year

studentID

the student's ID.

termIDs

the 3 or 4 academic terms in the year.

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