API Documentation

Class

AcademicTermCollection

api/academic-term.AcademicTermCollection()

Represents a specific academicTerm, such as "Spring, 2016", "Fall, 2017", or "Summer, 2015".

Constructor

# new AcademicTermCollection()

Creates the AcademicTerm collection.

View Source api/academic-term/AcademicTermCollection.ts, line 16

Extends

Methods

# assertAcademicTerm(term)

Ensures the passed object is a Academic Term instance.

Parameters:
Name Type Description
term

Should be a defined termID or academic term doc.

View Source api/academic-term/AcademicTermCollection.ts, line 150

If academicTerm is not a Academic Term.

Meteor.Error

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

Default implementation of assertValidRoleForMethod. Asserts that userId is logged in as an Admin or Advisor. 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/base/BaseCollection.ts, line 280

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

Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 369

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(Object)

Retrieves the docID for the specified Academic Term, or defines it if not yet present. Implicitly defines the corresponding slug: Spring, 2016 academicTerm is "Spring-2016".

Parameters:
Name Type Description
Object Object

with keys term, academicTerm. Term must be one of AcademicTerms.FALL, AcademicTerms.SPRING, or AcademicTerms.SUMMER. Year must be between 1990 and 2050.
Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 81

If the term or year are not correctly specified.

Meteor.Error

The docID for this academicTerm instance.

Example
AcademicTerms.define({ term: AcademicTerms.FALL, year: 2015 });

# 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 AcademicTerm docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of a Academic Term.
Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 63

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 132

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 107

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# findDocBySlug(slug) → {Object}

Returns the instance associated with the passed slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

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

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The document representing the instance.

Object

# findIdBySlug(slug) → {String}

Return the docID of the instance associated with this slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

View Source api/base/BaseSlugCollection.ts, line 124

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The docID.

String

# findIdsBySlugs(slugs) → {Array}

Returns a list of docIDs associated with the instances associated with the list of slugs.

Parameters:
Name Type Description
slugs Array

A list or collection of slugs.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 134

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

A list of docIDs.

Array

# 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

# findSlugByID(docID) → {String}

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID
Overrides:

View Source api/base/BaseSlugCollection.ts, line 152

If docID is not associated with this entity.

Meteor.Error

The slug name

String

# getAcademicTerm(date) → {String}

Returns the academicTerm ID corresponding to the given date.

Parameters:
Name Type Description
date

The date as a string. Must be able to be parsed by moment();

View Source api/academic-term/AcademicTermCollection.ts, line 269

The termID that the date falls in.

String

# getAcademicTermDoc(date)

Returns the academicTerm document corresponding to the given date.

Parameters:
Name Type Description
date

The date.

View Source api/academic-term/AcademicTermCollection.ts, line 293

Object The academicTerm that the date falls in.

# 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

# getCurrentAcademicTermDoc()

Returns the academicTerm doc associated with the current academicTerm based upon the current timestamp. See AcademicTerms.FALL_START_DATE, SPRING_START_DATE, and SUMMER_START_DATE.

View Source api/academic-term/AcademicTermCollection.ts, line 220

# getCurrentAcademicTermNumber() → {number}

Returns the current academic term number.

View Source api/academic-term/AcademicTermCollection.ts, line 237

the current academic term number.

number

# getCurrentTermID()

Returns the termID associated with the current academicTerm based upon the current timestamp. See AcademicTerms.FALL_START_DATE, SPRING_START_DATE, and SUMMER_START_DATE.

View Source api/academic-term/AcademicTermCollection.ts, line 169

# 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

# getID(academicTerm)

Returns the academicTerm docID associated with the passed academicTerm slug or docID. If the academicTerm does not exist, it is defined.

Parameters:
Name Type Description
academicTerm

The Slug or docID associated with a academicTerm
Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 304

If the passed academicTerm is not a valid academicTerm slug.

Meteor.Error

The academicTerm ID.

# getIDs(instances) → {Array.<String>}

Returns the docIDs associated with instances, or throws an error if any cannot be found. If an instance is a docID, then it is returned unchanged. If a slug, its corresponding docID is returned. If nothing is passed, then an empty array is returned.

Parameters:
Name Type Description
instances Array.<String>

An array of valid docIDs, slugs, or a combination.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 58

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getNextYears(numYears) → {Array.<AcademicTerm>}

Returns the academic terms for the next numYears. It returns the terms based upon academic year. For example if the current term is Spring 2020 and numYears is 2. This method will return [Spring 2020, Summer 2020, Fall 2020, Spring 2021, Summer 2021]

Parameters:
Name Type Description
numYears number

View Source api/academic-term/AcademicTermCollection.ts, line 247

Array.<AcademicTerm>

# getPublicationName() → {String}

Return the publication name.

Overrides:

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

The publication name, as a string.

String

# getShortName(termID) → {string}

Returns a four character "shortname" for a academicTerm and year: Fa18, Sp19, Su20

Parameters:
Name Type Description
termID

The academicTerm

View Source api/academic-term/AcademicTermCollection.ts, line 333

The shortname.

string

# 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/base/BaseCollection.ts, line 222

.

SimpleSchema

# hasSlug(slug) → {boolean}

Returns true if the passed slug is associated with an entity of this type.

Parameters:
Name Type Description
slug String

Either the name of a slug or a slugID.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 115

True if the slug is in this collection.

boolean

# isDefined(instance) → {boolean}

Return true if instance is a docID or a slug for this entity.

Parameters:
Name Type Description
instance String

A docID or a slug.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 106

True if instance is a docID or slug for this entity.

boolean

# isUpcomingTerm(term)

Returns true if the passed academicTerm occurs now or in the future.

Parameters:
Name Type Description
term

The academic term (slug or termID).

View Source api/academic-term/AcademicTermCollection.ts, line 212

True if academic term is in the future.

# publish()

Default publication method for entities. It publishes the entire collection.

Overrides:

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

# 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(instance)

Remove the Course.

Parameters:
Name Type Description
instance

The docID or slug of the entity to be removed.
Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 345

If docID is not a Course, or if this course has any associated course instances.

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

# sort()

Returns the instances sorted by slug string. Instances could be instanceIDs or slug names. Only tested so far with instances being slug names. Hopefully this.findDocBySlug resolves 'this' to the subcollection.

Overrides:

View Source api/base/BaseSlugCollection.ts, line 92

# subscribe()

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

Overrides:

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

# toString(termID, nospace) → {String}

Returns the passed academicTerm, formatted as a string.

Parameters:
Name Type Description
termID

The academicTerm.
nospace

If true, then term and year are concatenated without a space in between.
Overrides:

View Source api/academic-term/AcademicTermCollection.ts, line 323

The academicTerm as a string.

String

# update(docID, retired)

Updates the retired flag.

Parameters:
Name Type Description
docID

the id of the academicTerm.
retired

optional boolean.

View Source api/academic-term/AcademicTermCollection.ts, line 137