# new StudentProfileCollection()
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:
If instances is not an array, or if any instance is not in this collection.
# 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:
If not defined.
# assertValidLevel(level)
Asserts that level is an integer between 1 and 6.
Parameters:
| Name | Type | Description |
|---|---|---|
level |
The level. |
# 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:
If there is no logged in user, or the user is not an Admin or Advisor.
# 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:
A (possibly empty) array of strings indicating integrity issues.
# checkIntegrityCommonFields(doc) → {Array}
Internal method for use by subclasses.
Parameters:
| Name | Type | Description |
|---|---|---|
doc |
The profile document. |
- Overrides:
An array of problems
# count() → {Number}
Returns the number of documents in this collection.
The number of elements in this collection.
# countNonRetired() → {Number}
Returns the number of non-retired documents in this collection.
- Overrides:
The number of non-retired elements in this collection.
# define(username, firstName, lastName, picture, website, interests, careerGoals, level, retired, declaredAcademicTerm, isAlumni, sharePicture, shareWebsite, shareInterests, shareCareerGoals, shareCourses, shareOpportunities, shareLevel, shareICE, lastVisited) → {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) |
|
declaredAcademicTerm |
An optional string indicating the student's declared academic term. |
|
isAlumni |
An optional boolean indicating if this student has graduated. 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. |
|
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. |
|
shareICE |
An optional boolean indicating if this student is sharing their ICE points. Defaults to false. |
|
lastVisited |
An optional object with PAGEIDS for keys and strings in format "YYYY-MM-DD" for values. Defaults to an empty object. |
- Overrides:
If username has been previously defined, or if any interests, careerGoals, level, or declaredAcademicTerm are invalid.
The docID of the StudentProfile.
# 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.
An object representing the contents of this collection.
# 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:
An object representing the definition of docID.
# 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:
# 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:
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. |
If the document cannot be found.
The document associated with name.
# findDocBySlug(slug) → {Object}
Returns the instance associated with the passed slug.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | The slug (string or docID). |
- Overrides:
If the slug cannot be found, or is not associated with an instance in this collection.
The document representing the instance.
# 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:
If the slug cannot be found, or is not associated with an instance in this collection.
The docID.
# 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:
If the slug cannot be found, or is not associated with an instance in this collection.
A list of docIDs.
# 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:
non-retired documents.
# 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:
# findSlugByID(docID) → {String}
Returns the slug name associated with this docID.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID |
- Overrides:
If docID is not associated with this entity.
The slug name
# getCollection() → {Mongo.Collection}
Returns the Mongo collection.
- Overrides:
The collection.
# getCollectionName() → {string}
Returns the collection name.
- Overrides:
The collection name as a string.
# getCollectionNameForProfile(profile) → {String}
Returns the name of the collection associated with the given profile.
Parameters:
| Name | Type | Description |
|---|---|---|
profile |
A Profile object. |
- Overrides:
The name of a profile collection.
# getCollectionSchema() → {SimpleSchema}
Returns the schema applied to the collection.
- Overrides:
.
# getCourseIDs(userID)
Returns an array of courseIDs that this user has taken (or plans to take) based on their courseInstances.
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
The userID. |
# getDefineSchema() → {SimpleSchema}
Returns a schema for the define method's parameter.
- Overrides:
the define method's parameter.
# 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). |
If userID is not defined.
# getFakeUserId() → {string}
The subclass methods need a way to create a profile with a valid, though fake, userId.
- Overrides:
# 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:
If instance is not a docID or a slug.
The docID associated with instance.
# 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:
If any instance is not a docID or a slug.
The docIDs associated with instances.
# 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:
If user is not a valid user, or profile is not found.
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). |
If user is not defined.
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# getUpdateSchema() → {SimpleSchema}
Returns a schema for the update method's second parameter.
- Overrides:
.
# getUserID(profileID)
Returns the userID associated with the given profile.
Parameters:
| Name | Type | Description |
|---|---|---|
profileID |
The ID of the profile. |
- Overrides:
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:
If user is not a valid user.
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:
# 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:
True if the slug is in this collection.
# 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:
True if instance is a docID or slug for this entity.
# isDegreePlanComplete(user) → {boolean}
Returns true if projected innovation, competency, and experience points are all 100 or above.
Parameters:
| Name | Type | Description |
|---|---|---|
user |
string | The username. |
True if degree plan is complete.
# publish()
Override the BaseCollection.publish. We only publish profiles if the user is logged in.
# 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:
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. |
# 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. |
# 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:
The docID of the newly created document.
# setLevel(user, level)
Updates user's level.
Parameters:
| Name | Type | Description |
|---|---|---|
user |
The user (username or userID). |
|
level |
The new level. |
# 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.
# subscribe()
Default subscription method for entities. It subscribes to the entire collection.
# toString() → {String}
Returns a string representing all of the documents in this collection.
# update(docID, firstName, lastName, picture, website, interests, careerGoals, level, declaredAcademicTerm, isAlumni, retired, sharePicture, shareWebsite, shareInterests, shareCareerGoals, shareCourses, shareOpportunities, shareLevel, shareICE)
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 |
array of interest slugs or IDs. |
|
careerGoals |
||
level |
||
declaredAcademicTerm |
||
isAlumni |
||
retired |
||
sharePicture |
||
shareWebsite |
||
shareInterests |
||
shareCareerGoals |
||
shareCourses |
||
shareOpportunities |
||
shareLevel |
||
shareICE |
# updateCommonFields()
Internal method for use by subclasses. Destructively modifies updateData with the values of the passed fields. Call this function for side-effect only.
# updateLastVisitedEntry(user, page)
Updates an entry in lastVisited for this profile with a new (or updated) timestamp for the given page.
Parameters:
| Name | Type | Description |
|---|---|---|
user |
user The user (either their username (email) or their userID). |
|
page |
The page. Should be one of PAGEIDS. |