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, retired) → {void|*|boolean|Object}
Defines a new ProfileCareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
careerGoal |
the careerGoal slug. |
|
username |
the user's username. |
|
retired |
the retired status. |
# dumpOne(docID) → {Object}
Returns an object representing the ProfileCareerGoal docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of a ProfileCareerGoal. |
An object representing the definition of docID.
# dumpUser(usernameOrID) → {Array.<ProfileCareerGoalDefine>}
Dumps all the ProfileCareerGoals for the given usernameOrID.
Parameters:
| Name | Type | Description |
|---|---|---|
usernameOrID |
string |
# getCareerGoalDoc(instanceID) → {Object}
Returns the CareerGoal associated with the ProfileCareerGoal 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 Profile's corresponding CareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ProfileCareerGoal ID. |
The careerGoal slug.
# getCareerGoalSlugs(username) → {Array.<any>}
Returns the list of non-retired Career Goal slugs associated with this username.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
The username |
Career Goal slugs.
# getStudentDoc(instanceID) → {Object}
Returns the Student profile associated with the ProfileCareerGoal with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ID of the ProfileCareerGoal. |
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 ProfileCareerGoal id. |
# publish()
Publish ProfileCareerGoals. If ADMIN get all, otherwise only get the ProfileCareerGoals for the userID. Also publishes the ProfileCareerGoals forecast.
# removeIt(docID)
Remove the ProfileCareerGoal.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of the ProfileCareerGoal. |
# removeUser(user)
Removes all the ProfileCareerGoals 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 ProfileCareerGoal. |
|
retired |
the new retired value. |