API Documentation

Class

OpportunityInstanceCollection

api/opportunity.OpportunityInstanceCollection()

OpportunityInstances indicate that a student wants to take advantage of an Opportunity in a specific academic term.

Constructor

# new OpportunityInstanceCollection()

Creates the OpportunityInstance collection.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 19

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:

View Source api/base/BaseCollection.ts, line 268

If instances is not an array, or if any instance is not in this collection.

Meteor.Error

# 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:

View Source api/base/BaseCollection.ts, line 258

If not defined.

Meteor.Error

# 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:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 165

If there is no logged in user, or the user is not an Admin or Advisor.

Meteor.Error

# 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 termID, opportunityID, studentID

Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 326

A (possibly empty) array of strings indicating integrity issues.

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 71

The number of elements in this collection.

Number

# countNonRetired() → {Number}

Returns the number of non-retired documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 78

The number of non-retired elements in this collection.

Number

# define(description)

Defines a new OpportunityInstance.

Parameters:
Name Type Description
description Object

AcademicTerm, opportunity, and student must be slugs or IDs. Verified defaults to false. Sponsor defaults to the opportunity sponsor. Note that only one opportunity instance can be defined for a given academicTerm, opportunity, and student.
Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 69

If academicTerm, opportunity, or student cannot be resolved, or if verified is not a boolean.

Meteor.Error

The newly created docID.

Example
OpportunityInstances.define({ academicTerm: 'Fall-2015',
                              opportunity: 'hack2015',
                              verified: false,
                              student: 'joesmith',
                             sponsor: 'johnson' });

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 297

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

Returns an object representing the OpportunityInstance docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of an OpportunityInstance.
Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 355

An object representing the definition of docID.

Object

# dumpUser(usernameOrID) → {Array.<OpportunityInstanceDefine>}

Dumps the OpportunityInstances for the given usernameOrID.

Parameters:
Name Type Description
usernameOrID string

View Source api/opportunity/OpportunityInstanceCollection.ts, line 370

Array.<OpportunityInstanceDefine>

# 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:

View Source api/base/BaseCollection.ts, line 132

Mongo.Cursor

# 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.
Overrides:

View Source api/base/BaseCollection.ts, line 107

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# 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:

View Source api/base/BaseCollection.ts, line 143

non-retired documents.

Array

# 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:

View Source api/base/BaseCollection.ts, line 154

Mongo.Cursor

# findOpportunityInstanceDoc(academicTerm, opportunity, student) → {Object}

Returns the opportunityInstance document associated with academicTerm, opportunity, and student.

Parameters:
Name Type Description
academicTerm

The academicTerm (slug or ID).
opportunity

The opportunity (slug or ID).
student

The student (slug or ID)

View Source api/opportunity/OpportunityInstanceCollection.ts, line 176

If academicTerm, opportunity, or student does not exist.

Meteor.Error

Returns the document or null if not found.

Object

# getAcademicTermDoc(instanceID) → {Object}

Returns the AcademicTerm associated with the OpportunityInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the OpportunityInstance.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 220

If instanceID is not a valid ID.

Meteor.Error

The associated AcademicTerm.

Object

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

View Source api/base/BaseCollection.ts, line 243

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

View Source api/base/BaseCollection.ts, line 236

The collection name as a string.

string

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

View Source api/base/BaseCollection.ts, line 208

.

SimpleSchema

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 215

the define method's parameter.

SimpleSchema

# getOpportunityDoc(instanceID) → {Object}

Returns the Opportunity associated with the OpportunityInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the OpportunityInstance.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 199

If instanceID is not a valid ID.

Meteor.Error

The associated Opportunity.

Object

# getOpportunitySlug(instanceID) → {string}

Returns the Opportunity slug for the instance's corresponding Opportunity.

Parameters:
Name Type Description
instanceID

The OpportunityInstance ID.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 209

The opportunity slug.

string

# getPublicationName() → {String}

Return the publication name.

Overrides:

View Source api/base/BaseCollection.ts, line 229

The publication name, as a string.

String

# getPublicationNames() → {Object}

Gets the publication names.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 284

The publication names.

Object

# getStudentDoc(instanceID) → {Object}

Returns the Student profile associated with the OpportunityInstance with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the OpportunityInstance.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 231

If instanceID is not a valid ID.

Meteor.Error

The associated Student profile.

Object

# getType() → {String}

Return the type of this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 201

The type, as a string.

String

# getUnverifiedInstances(student) → {Array.<OpportunityInstance>}

Returns the unverified opportunity instances for the given student.

Parameters:
Name Type Description
student string

username or ID.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 241

the unverified opportunity instances.

Array.<OpportunityInstance>

# getUpdateSchema() → {SimpleSchema}

Returns a schema for the update method's second parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 222

.

SimpleSchema

# isDefined(name) → {boolean}

Returns true if the passed entity is in this collection.

Parameters:
Name Type Description
name String | Object

The docID, or an object specifying a documennt.
Overrides:

View Source api/base/BaseCollection.ts, line 163

True if name exists in this collection.

boolean

# isOpportunityInstance(academicTerm, opportunity, student)

Returns true if there exists an OpportunityInstance for the given academicTerm, opportunity, and student.

Parameters:
Name Type Description
academicTerm

The academicTerm (slug or ID).
opportunity

The opportunity (slug or ID).
student

The student (slug or ID).

View Source api/opportunity/OpportunityInstanceCollection.ts, line 190

If academicTerm, opportunity, or student does not exist.

Meteor.Error

True if the opportunity instance exists.

# publish()

Depending on the logged in user publish only their OpportunityInstances. If the user is in the Role.ADMIN then publish all OpportunityInstances.

Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 258

# 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:

View Source api/base/BaseCollection.ts, line 190

true

# removeIt(docID)

Remove the opportunity instance.

Parameters:
Name Type Description
docID

The docID of the opportunity instance.
Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 139

# removeUser(user)

Removes all OpportunityInstance documents referring to user.

Parameters:
Name Type Description
user

The user, either the ID or the username.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 154

If user is not an ID or username.

Meteor.Error

# 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.
Overrides:

View Source api/base/BaseCollection.ts, line 335

# 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:

View Source api/base/BaseCollection.ts, line 325

The docID of the newly created document.

String

# subscribe()

Default subscription method for entities. It subscribes to the entire collection.

Overrides:

View Source api/base/BaseCollection.ts, line 94

# toString(opportunityInstanceID) → {String}

Parameters:
Name Type Description
opportunityInstanceID

The opportunity instance ID.
Overrides:

View Source api/opportunity/OpportunityInstanceCollection.ts, line 292

If not a valid ID.

Meteor.Error

This opportunity instance, formatted as a string.

String

# update(docID, termID, verified, ice)

Update the opportunity instance. Only verified and ICE fields can be updated.

Parameters:
Name Type Description
docID

The course instance docID (required).
termID

the termID for the course instance optional.
verified

boolean optional.
ice

an object with fields i, c, e (optional)

View Source api/opportunity/OpportunityInstanceCollection.ts, line 118

# updateAcademicTerm(opportunityInstanceID, termID)

Updates the OpportunityInstance's AcademicTerm.

Parameters:
Name Type Description
opportunityInstanceID

The opportunity instance ID.
termID

The academicTerm id.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 305

If not a valid ID.

Meteor.Error

# updateVerified(opportunityInstanceID, verified)

Updates the verified field.

Parameters:
Name Type Description
opportunityInstanceID

The opportunity instance ID.
verified

The new value of verified.

View Source api/opportunity/OpportunityInstanceCollection.ts, line 316

If not a valid ID.

Meteor.Error