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, opportunityID, and userID.
A (possibly empty) array of strings indicating integrity issues.
# define(opportunity, username, retired) → {void|*|boolean|Object}
Defines a new ProfileOpportunity.
Parameters:
| Name | Type | Description |
|---|---|---|
opportunity |
the opportunity slug. |
|
username |
the username's username. |
|
retired |
the retired status. |
# dumpOne(docID) → {Object}
Returns an object representing the ProfileOpportunity docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of a ProfileOpportunity. |
An object representing the definition of docID.
# dumpUser(usernameOrID) → {Array.<ProfileOpportunityDefine>}
Dumps all the ProfileOpportunites for the given usernameOrID.
Parameters:
| Name | Type | Description |
|---|---|---|
usernameOrID |
string |
# getOpportunityDoc(instanceID) → {Object}
Returns the Opportunity associated with the ProfileOpportunity with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The id of the OpportunityInstance. |
If instanceID is not a valid ID.
The associated Opportunity.
# getOpportunitySlug(instanceID) → {string}
Returns the Opportunity slug for the profile's corresponding Opportunity.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ProfileOpportunity ID. |
The opportunity slug.
# getOpportunitySlugs(username) → {Array.<any>}
Returns the list of non-retired Opportunity slugs associated with this username.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
The username |
Opportunity slugs.
# getStudentDoc(instanceID) → {Object}
Returns the Student profile associated with the ProfileOpportunity with the given instanceID.
Parameters:
| Name | Type | Description |
|---|---|---|
instanceID |
The ID of the ProfileOpportunity. |
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 ProfileOpportunity id. |
# publish()
Publish ProfileOpportunities. If logged in as ADMIN get all, otherwise only get the ProfileOpportunities for the userID. Also publishes the ProfileOpportunities forecast.
# removeIt(docID)
Remove the ProfileOpportunity.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of the ProfileOpportunity. |
# removeUser(user)
Removes all the ProfileOpportunities 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 ProfileOpportunity. |
|
retired |
the new retired value. |