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, careerGoalID, and userID.
A (possibly empty) array of strings indicating integrity issues.
# define(careerGoal, username, share, retired) → {void|*|boolean|Object}
Defines a new FavoriteCareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
careerGoal |
the careerGoal slug. |
|
username |
the user's username. |
|
share |
Boolean | share the favorite career goal? Defaults to false. |
retired |
the retired status. |
# dumpOne(docID) → {Object}
Returns an object representing the FavoriteAcademicPlan docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of a FavoriteAcademicPlan. |
An object representing the definition of docID.
# getCareerGoalDoc(instanceID) → {Object}
Returns the CareerGoal associated with the FavoriteCareerGoal with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The id of the CareerGoalInstance. |
If instanceID is not a valid ID.
The associated CareerGoal.
# getCareerGoalSlug(instanceID) → {string}
Returns the CareerGoal slug for the favorite's corresponding CareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The FavoriteCareerGoal ID. |
The careerGoal slug.
# getStudentDoc(instanceID) → {Object}
Returns the Student profile associated with the FavoriteCareerGoal with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ID of the FavoriteCareerGoal. |
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 FavoriteCareerGoal id. |
# publish()
Publish CareerGoalFavorites. If logged in as ADMIN get all, otherwise only get the CareerGoalFavorites for the userID. Also publishes the CareerGoalFavorites scoreboard.
# removeIt(docID)
Remove the FavoriteCareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of the FavoriteCareerGoal. |
# removeUser(user)
Removes all the FavoriteCareerGoals 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 FavoriteCareerGoal. |
|
retired |
the new retired value. |