Class

StudentProfileCollection

api/user.StudentProfileCollection()

Represents a Student Profile.

Constructor

# new StudentProfileCollection()

View Source api/user/StudentProfileCollection.ts, line 30

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 248

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 238

If not defined.

Meteor.Error

# assertValidLevel(level)

Asserts that level is an integer between 1 and 6.

Parameters:
Name Type Description
level

The level.

View Source api/user/StudentProfileCollection.ts, line 324

# 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/user/StudentProfileCollection.ts, line 336

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

Overrides:

View Source api/user/StudentProfileCollection.ts, line 345

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

Array

# checkIntegrityCommonFields(doc) → {Array}

Internal method for use by subclasses.

Parameters:
Name Type Description
doc

The profile document.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 164

An array of problems

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

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

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 48

The number of non-retired elements in this collection.

Number

# define(username, firstName, lastName, picture, website, interests, careerGoals, level, retired, academicPlan, declaredAcademicTerm, isAlumni, shareUsername, sharePicture, shareWebsite, shareInterests, shareCareerGoals, shareAcademicPlan, shareCourses, shareOpportunities, shareLevel) → {String}

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.

retired

boolean. (optional defaults to false)

academicPlan

An optional slug indicating the academic plan.

declaredAcademicTerm

An optional string indicating the student's declared academic term.

isAlumni

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

shareUsername

An optional boolean indicating if this student is sharing their username. Defaults to false.

sharePicture

An optional boolean indicating if this student is sharing their picture. Defaults to false.

shareWebsite

An optional boolean indicating if this student is sharing their website. Defaults to false.

shareInterests

An optional boolean indicating if this student is sharing their interests. Defaults to false.

shareCareerGoals

An optional boolean indicating if this student is sharing their career goals. Defaults to false.

shareAcademicPlan

An optional boolean indicating if this student is sharing their academic plans. Defaults to false.

shareCourses

An optional boolean indicating if this student is sharing their courses. Defaults to false.

shareOpportunities

An optional boolean indicating if this student is sharing their opportunities. Defaults to false.

shareLevel

An optional boolean indicating if this student is sharing their level. Defaults to false.

Overrides:

View Source api/user/StudentProfileCollection.ts, line 131

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

Meteor.Error

The docID of the StudentProfile.

String

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

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

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

Parameters:
Name Type Description
docID

The docID of a StudentProfile

Overrides:

View Source api/user/StudentProfileCollection.ts, line 544

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 101

Mongo.Cursor

# findByUsername(username)

Returns the profile document associated with username, or null if none was found.

Parameters:
Name Type Description
username

A username, such as 'johnson@hawaii.edu'.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 124

The profile document, or null.

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

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 128

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 109

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 119

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 112

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 123

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 137

If docID is not associated with this entity.

Meteor.Error

The slug name

String

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

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

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

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

The collection name as a string.

string

# getCollectionNameForProfile(profile) → {String}

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

Parameters:
Name Type Description
profile

A Profile object.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 67

The name of a profile collection.

String

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

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

.

SimpleSchema

# getCourseIDs(studentID)

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.

View Source api/user/StudentProfileCollection.ts, line 393

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

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

the define method's parameter.

SimpleSchema

# getEarnedICE(user)

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

Parameters:
Name Type Description
user

The student (username or userID).

View Source api/user/StudentProfileCollection.ts, line 372

If userID is not defined.

Meteor.Error

# getFakeUserId() → {string}

The subclass methods need a way to create a profile with a valid, though fake, userId.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 59

string

# getID(instance) → {String}

Returns the Profile's 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 the userID for the profile, then return the Profile'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, valid userID or a valid slug string.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 80

If instance is not a docID or a slug.

Meteor.Error

The docID associated with instance.

String

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

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getInterestIDs(userID) → {Array}

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

Parameters:
Name Type Description
userID

View Source api/user/StudentProfileCollection.ts, line 405

Array

# getInterestIDsByType(userID)

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.

View Source api/user/StudentProfileCollection.ts, line 423

# getProfile(user)

Returns the profile associated with the specified user.

Parameters:
Name Type Description
user

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

Overrides:

View Source api/user/BaseProfileCollection.ts, line 111

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

Meteor.Error

The profile document.

# getProjectedICE(user)

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

Parameters:
Name Type Description
user

The student (username or userID).

View Source api/user/StudentProfileCollection.ts, line 383

If user is not defined.

Meteor.Error

# getPublicationName() → {String}

Return the publication name.

Overrides:

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

The publication name, as a string.

String

# getType() → {String}

Return the type of this collection.

Overrides:

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

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 202

.

SimpleSchema

# getUserID(profileID)

Returns the userID associated with the given profile.

Parameters:
Name Type Description
profileID

The ID of the profile.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 156

The associated userID.

# hasProfile(user)

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

Overrides:

View Source api/user/BaseProfileCollection.ts, line 133

If user is not a valid user.

Meteor.Error

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

# hasSetPicture(user) → {boolean}

Returns true if the user has set their picture.

Parameters:
Name Type Description
user

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

Overrides:

View Source api/user/BaseProfileCollection.ts, line 142

boolean

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

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 91

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

boolean

# publish()

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

Overrides:

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

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

true

# removeIt(profileID)

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.

Overrides:

View Source api/user/StudentProfileCollection.ts, line 314

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

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

The docID of the newly created document.

String

# setLevel(user, level)

Updates user's level.

Parameters:
Name Type Description
user

The user (username or userID).

level

The new level.

View Source api/user/StudentProfileCollection.ts, line 446

# subscribe()

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

Overrides:

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

# toString() → {String}

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

Overrides:

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

String

# update(docID, firstName, lastName, picture, website, interests, careerGoals, level, academicPlan, declaredAcademicTerm, isAlumni, retired, shareUsername, sharePicture, shareWebsite, shareInterests, shareCareerGoals, shareAcademicPlan, shareCourses, shareOpportunities, shareLevel)

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
firstName
lastName
picture
website
interests
careerGoals
level
academicPlan
declaredAcademicTerm
isAlumni
retired
shareUsername
sharePicture
shareWebsite
shareInterests
shareCareerGoals
shareAcademicPlan
shareCourses
shareOpportunities
shareLevel

View Source api/user/StudentProfileCollection.ts, line 217

# updateCommonFields()

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

Overrides:

View Source api/user/BaseProfileCollection.ts, line 198