Methods
# 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 |
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 semesterID, interestID, and userID.
A (possibly empty) array of strings indicating integrity issues.
# define(interest, student, retired) → {void|*|boolean|Object}
Defines a new ProfileInterest.
Parameters:
| Name | Type | Description |
|---|---|---|
interest |
the interest slug. |
|
student |
the student's username. |
|
retired |
the retired status. |
# dumpOne(docID) → {ProfileInterestDefine}
Returns an object representing the ProfileInterest with given docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
the docID of a ProfileInterest |
# dumpUser(usernameOrID) → {Array.<ProfileInterestDefine>}
Dumps all the ProfileInterests for the given usernameOrID.
Parameters:
| Name | Type | Description |
|---|---|---|
usernameOrID |
string |
# getInterestDoc(instanceID) → {Object}
Returns the Interest associated with the ProfileInterest with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The id of the InterestInstance. |
If instanceID is not a valid ID.
The associated Interest.
# getInterestSlug(instanceID) → {string}
Returns the Interest slug for the profile's corresponding Interest.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ProfileInterest ID. |
The interest slug.
# getInterestSlugs(username) → {Array.<any>}
Returns the list of non-retired Interest slugs associated with this username.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
The username |
Interest slugs.
# getStudentDoc(instanceID) → {Object}
Returns the Student profile associated with the ProfileInterest with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ID of the ProfileInterest. |
If instanceID is not a valid ID.
The associated Student profile.
# getStudentUsername(instanceID) → {*}
Returns the username associated with the userID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
the ProfileInterest id. |
# publish()
Publish ProfileInterests. If logged in as ADMIN get all, otherwise only get the ProfileInterests for the studentID. Also publishes the ProfileInterests forecast.
# removeIt(docID)
Remove the ProfileInterest.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of the ProfileInterest. |
# removeUser(user)
Removes all the ProfileInterests for the user.
Parameters:
| Name | Type | Description |
|---|---|---|
user |
the username. |
# update(docID, retired)
Updates the retired status.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
the ID of the ProfileInterest. |
|
retired |
the new retired value. |