StudentProfileCollection

api/user. StudentProfileCollection

Represents a Student Profile.

Constructor

new StudentProfileCollection()

Source:

Extends

Methods

_checkIntegrityCommonFields(doc) → {Array}

Source:
Inherited From:

Internal method for use by subclasses.

Parameters:
Name Type Description
doc

The profile document.

Returns:

An array of problems

Type
Array

_updateCommonFields()

Source:
Inherited From:

Internal method for use by subclasses.
Destructively modifies updateData with the values of the passed fields.
Call this function for side-effect only.

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

assertValidLevel(level)

Source:

Asserts that level is an integer between 1 and 6.

Parameters:
Name Type Description
level

The level.

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 the profile common fields and the role..

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(username, firstName, lastName, picture, website, interests, careerGoals, level, academicPlan, declaredSemester, hiddenCourses, hiddenOpportunities, isAlumni) → {String}

Source:

Defines the profile associated with a Student.
The username does not need to be defined in Meteor Accounts yet, but it must be a unique Slug.

Parameters:
Name Type Description
username

The username string associated with this profile, which should be an email.

firstName

The first name.

lastName

The last name.

picture

The URL to their picture. (optional, defaults to a default picture.)

website

The URL to their personal website (optional).

interests

An array of interests. (optional)

careerGoals

An array of career goals. (optional)

level

An integer between 1 and 6 indicating the student's level.

academicPlan

An optional slug indicating the academic plan.

declaredSemester

An optional string indicating the student's declared semester.

hiddenCourses

An optional array of course slugs indicating the hidden ones.

hiddenOpportunities

An optional array of opportunity slugs indicating the hidden opportunities.

isAlumni

An optional boolean indicating if this student has graduated. Defaults to false.

Throws:

If username has been previously defined, or if any interests, careerGoals, level,
academicPlan, declaredSemester, hiddenCourses, or hiddenOpportunities are invalid.

Type
Meteor.Error
Returns:

The docID of the StudentProfile.

Type
String

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

Parameters:
Name Type Description
docID

The docID of a StudentProfile

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

findDocBySlug(slug) → {Object}

Source:
Inherited From:

Returns the instance associated with the passed slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).

Throws:

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

Type
Meteor.Error
Returns:

The document representing the instance.

Type
Object

findIdBySlug(slug) → {String}

Source:
Inherited From:

Return the docID of the instance associated with this slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).

Throws:

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

Type
Meteor.Error
Returns:

The docID.

Type
String

findIdsBySlugs(slugs) → {Array}

Source:
Inherited From:

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.

Throws:

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

Type
Meteor.Error
Returns:

A list of docIDs.

Type
Array

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

findSlugByID(docID) → {String}

Source:
Inherited From:

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID

Throws:

If docID is not associated with this entity.

Type
Meteor.Error
Returns:

The slug name

Type
String

getCollectionName() → {string}

Source:
Inherited From:

Returns the collection name.

Returns:

The collection name as a string.

Type
string

getCollectionNameForProfile(profile) → {String}

Source:
Inherited From:

Returns the name of the collection associated with the given profile.

Parameters:
Name Type Description
profile

A Profile object.

Returns:

The name of a profile collection.

Type
String

getCourseIDs(studentID)

Source:

Returns an array of courseIDs that this user has taken (or plans to take) based on their courseInstances.

Parameters:
Name Type Description
studentID

The studentID.

getEarnedICE(user)

Source:

Returns an ICE object with the total earned course and opportunity ICE values.

Parameters:
Name Type Description
user

The student (username or userID).

Throws:

If userID is not defined.

Type
Meteor.Error

getID(instance) → {String}

Source:
Inherited From:

Returns the docID associated with instance, or throws an error if it cannot be found.
If instance is a docID, then it is returned unchanged. If instance is a slug, its corresponding docID is returned.
If instance is the value for the username field in this collection, then return that document's ID.
If instance is an object with an _id field, then that value is checked to see if it's in the collection.

Parameters:
Name Type Description
instance String

Either a valid docID or a valid slug string.

Throws:

If instance is not a docID or a slug.

Type
Meteor.Error
Returns:

The docID associated with instance.

Type
String

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

Source:
Inherited From:

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.

Throws:

If any instance is not a docID or a slug.

Type
Meteor.Error
Returns:

The docIDs associated with instances.

Type
Array.<String>

getInterestIDs(userID) → {Array}

Source:

Returns the user's interests as IDs. It is a union of interestIDs and careerGoal interestIDs.

Parameters:
Name Type Description
userID
Returns:
Type
Array

getInterestIDsByType(userID)

Source:

Returns the user's interest IDs in an Array with two sub-arrays. The first sub-array is the interest IDs that the
User selected. The second sub-array is the interestIDs from the user's career goals.

Parameters:
Name Type Description
userID

The user's ID.

getProfile(user)

Source:
Inherited From:

Returns the profile associated with the specified user.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

Throws:

If user is not a valid user, or profile is not found.

Type
Meteor.Error
Returns:

The profile document.

getProjectedICE(user)

Source:

Returns an ICE object with the total projected course and opportunity ICE values.

Parameters:
Name Type Description
user

The student (username or userID).

Throws:

If user is not defined.

Type
Meteor.Error

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

getUserID(profileID)

Source:
Inherited From:

Returns the userID associated with the given profile.

Parameters:
Name Type Description
profileID

The ID of the profile.

Returns:

The associated userID.

hasProfile(user)

Source:
Inherited From:

Returns non-null if the user has a profile in this collection.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

Throws:

If user is not a valid user.

Type
Meteor.Error
Returns:

The profile document if the profile exists, or null if not found.

hasSlug(slug) → {boolean}

Source:
Inherited From:

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.

Returns:

True if the slug is in this collection.

Type
boolean

isDefined(instance) → {boolean}

Source:
Inherited From:

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

Parameters:
Name Type Description
instance String

A docID or a slug.

Returns:

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

Type
boolean

publish()

Source:
Inherited From:

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

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

Source:
Inherited From:

Removes this profile, given its profile ID.
Also removes this user from Meteor Accounts.

Parameters:
Name Type Description
profileID

The ID for this profile object.

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

setLevel(user, level)

Source:

Updates user's level.

Parameters:
Name Type Description
user

The user (username or userID).

level

The new level.

subscribe()

Source:
Inherited From:

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

toString() → {String}

Source:
Inherited From:

Returns a string representing all of the documents in this collection.

Returns:
Type
String

update(docID, company, career, location, linkedin, motivation)

Source:
Overrides:

Updates the StudentProfile.
You cannot change the username or role once defined. (You can implicitly change the role by setting isAlumni).
Users in ROLE.STUDENT cannot change their level or isAlumni setting.

Parameters:
Name Type Description
docID

the id of the StudentProfile.

company

the company (optional).

career

the career (optional).

location

the location (optional).

linkedin

LinkedIn user ID (optional).

motivation

the motivation (optional).