API Documentation

Class

VerificationRequestCollection

api/verification.VerificationRequestCollection()

Represents a Verification Request, such as "LiveWire Internship". A student has completed an opportunity (such as an internship or project) and wants to obtain ICE Points by having it verified.

Constructor

# new VerificationRequestCollection()

Creates the VerificationRequest collection.

View Source api/verification/VerificationRequestCollection.ts, line 35

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/verification/VerificationRequestCollection.ts, line 121

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 studentID, opportunityInstanceID, termID.

Overrides:

View Source api/verification/VerificationRequestCollection.ts, line 282

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(student)

Defines a verification request.

Parameters:
Name Type Description
student Object

and opportunity must be slugs or IDs. SubmittedOn defaults to now. status defaults to OPEN, processed defaults to an empty array and retired defaults to false. You can either pass the opportunityInstanceID or pass the opportunity and academicTerm slugs. If opportunityInstance is not defined, then the student, opportunity, and academicTerm arguments are used to look it up.
Overrides:

View Source api/verification/VerificationRequestCollection.ts, line 87

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

Meteor.Error

The newly created docID.

Example
VerificationRequests.define({ student: 'joesmith',
                              opportunityInstance: 'EiQYeRP4jyyre28Zw' });
or
VerificationRequests.define({ student: 'joesmith',
                              opportunity: 'TechHui',
                             academicTerm: 'Fall-2015'});

# 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 VerificationRequest docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of an VerificationRequest.
Overrides:

View Source api/verification/VerificationRequestCollection.ts, line 302

An object representing the definition of docID.

Object

# 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

# findVerificationRequest(opportunityInstanceID)

Returns the VerificationRequestID associated with opportunityInstanceID, or null if not found.

Parameters:
Name Type Description
opportunityInstanceID

The opportunityInstanceID

View Source api/verification/VerificationRequestCollection.ts, line 129

The VerificationRequestID, or null if not found.

# getAcademicTermDoc(instanceID) → {IAcademicTerm}

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

Parameters:
Name Type Description
instanceID

The id of the VerificationRequest.

View Source api/verification/VerificationRequestCollection.ts, line 171

If instanceID is not a valid ID.

Meteor.Error

The associated AcademicTerm.

IAcademicTerm

# 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(verificationRequestID) → {IOpportunity}

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

Parameters:
Name Type Description
verificationRequestID

The id of the VerificationRequest.

View Source api/verification/VerificationRequestCollection.ts, line 148

If instanceID is not a valid ID.

Meteor.Error

The associated Opportunity.

IOpportunity

# getOpportunityInstanceDoc(verificationRequestID) → {Object}

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

Parameters:
Name Type Description
verificationRequestID

The id of the VerificationRequest.

View Source api/verification/VerificationRequestCollection.ts, line 160

If instanceID is not a valid ID.

Meteor.Error

The associated Opportunity.

Object

# getPublicationName() → {String}

Return the publication name.

Overrides:

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

The publication name, as a string.

String

# getSponsorDoc(instanceID) → {Object}

Returns the Sponsor (faculty) profile associated with the VerificationRequest with the given instanceID.

Parameters:
Name Type Description
instanceID

The id of the VerificationRequest.

View Source api/verification/VerificationRequestCollection.ts, line 183

If instanceID is not a valid ID.

Meteor.Error

The associated Faculty profile.

Object

# getStudentDoc(instanceID) → {Object}

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

Parameters:
Name Type Description
instanceID

The id of the VerificationRequest.

View Source api/verification/VerificationRequestCollection.ts, line 195

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

# 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

# publish()

Depending on the logged in user publish only their VerificationRequests. If the user is in the Role.ADMIN, ADVISOR or FACULTY then publish all Verification Requests.

Overrides:

View Source api/verification/VerificationRequestCollection.ts, line 204

# 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(name)

A stricter form of remove that throws an error if the document or docID could not be found in this collection.

Parameters:
Name Type Description
name String | Object

A document or docID in this collection.
Overrides:

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

true

# removeUser(user)

Removes all VerificationRequest documents referring to user.

Parameters:
Name Type Description
user

The user, either the ID or the username.

View Source api/verification/VerificationRequestCollection.ts, line 138

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

# setVerificationStatus(verificationRequestID, verifyingUser, status, feedback)

Sets the verification status of the passed VerificationRequest.

Parameters:
Name Type Description
verificationRequestID

The ID of the verification request.
verifyingUser

The user who is doing the verification.
status

The status (ACCEPTED, REJECTED, OPEN).
feedback

An optional feedback string.

View Source api/verification/VerificationRequestCollection.ts, line 268

If the verification request or user is not defined.

Meteor.Error

# setVerified(verificationRequestID, verifyingUser)

Sets the passed VerificationRequest to be verified.

Parameters:
Name Type Description
verificationRequestID

The VerificationRequest
verifyingUser

The user who did the verification.

View Source api/verification/VerificationRequestCollection.ts, line 251

If verificationRequestID or verifyingUser are not defined.

Meteor.Error

# subscribe()

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

Overrides:

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

# toString() → {String}

Returns a string representing all of the documents in this collection.

Overrides:

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

String

# update(docID, status, processed, retired)

Updates the VerificationRequest

Parameters:
Name Type Description
docID

the docID to update.
status string

optional
processed Array.<Processed>

optional
retired boolean

optional

View Source api/verification/VerificationRequestCollection.ts, line 110

# updateRetired(requestID, retired)

Sets the retired status of the retired flag.

Parameters:
Name Type Description
requestID

the VerificationRequest ID.
retired

the retired status.

View Source api/verification/VerificationRequestCollection.ts, line 241

# updateStatus(requestID, status, processed)

Updates the VerificationRequest's status and processed array.

Parameters:
Name Type Description
requestID

The VerificationRequest ID.
status

The new Status.
processed

The new array of process records.

View Source api/verification/VerificationRequestCollection.ts, line 232