AcademicYearInstanceCollection

api/degree-plan. AcademicYearInstanceCollection

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

Constructor

new AcademicYearInstanceCollection()

Source:

Creates the AcademicYearInstance 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 studentID, semesterIDs

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

Source:

Defines a new AcademicYearInstance.

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

with keys year and student.

Throws:

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

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

Parameters:
Name Type Description
docID

The docID of an AcademicYearInstance.

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

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

getPublicationName() → {String}

Source:
Inherited From:

Return the publication name.

Returns:

The publication name, as a string.

Type
String

getType() → {String}

Source:
Inherited From:

Return the type of this collection.

Returns:

The type, as a string.

Type
String

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

publish()

Source:
Overrides:

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

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 academic year.

Parameters:
Name Type Description
docID

The docID of the academic year.

removeUser(user)

Source:

Removes all AcademicYearInstance documents referring to user.

Parameters:
Name Type Description
user

The student, 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(academicYearInstanceID) → {String}

Source:
Overrides:
Parameters:
Name Type Description
academicYearInstanceID

The academic year instance ID.

Throws:

If not a valid ID.

Type
Meteor.Error
Returns:

A formatted string representing the academic year instance.

Type
String

update(docID, year, springYear, studentID, semesterIDs)

Source:
Overrides:

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.

semesterIDs

the 3 semesters in the year.