API Documentation

Class

OpportunityCollection

api/opportunity.OpportunityCollection()

Represents an Opportunity, such as "LiveWire Internship". To represent an Opportunity taken by a specific student in a specific academicTerm, use OpportunityInstance.

Constructor

# new OpportunityCollection()

Creates the Opportunity collection.

View Source api/opportunity/OpportunityCollection.ts, line 26

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)

Asserts that userId is logged in as an Admin, Faculty, or Advisor. 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/OpportunityCollection.ts, line 231

If there is no logged in user, or the user is not in the allowed roles.

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 slugID, opportunityTypeID, sponsorID, interestIDs, termIDs

Overrides:

View Source api/opportunity/OpportunityCollection.ts, line 251

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, name, slug, description, opportunityType, interests, sponsor, ice, eventDate1, eventDateLabel1, eventDate2, eventDateLabel2, eventDate3, eventDateLabel3, eventDate4, eventDateLabel4, picture, retired)

Defines a new Opportunity.

Parameters:
Name Type Description
description Object

Object with keys name, slug, description, opportunityType, sponsor, interests,
name

the name of the opportunity.
slug

must not be previously defined.
description

the description of the opportunity. Can be markdown.
opportunityType

must be defined slug.
interests

must be a (possibly empty) array of interest slugs or IDs.
sponsor

must be a User with role 'FACULTY', 'ADVISOR', or 'ADMIN'.
ice

must be a valid ICE object.
eventDate1
eventDateLabel1
eventDate2
eventDateLabel2
eventDate3
eventDateLabel3
eventDate4
eventDateLabel4
picture

The URL to the opportunity picture. (optional, defaults to a default picture.)
retired

optional, true if the opportunity is retired.
Overrides:

View Source api/opportunity/OpportunityCollection.ts, line 85

If the definition includes a defined slug or undefined interest, sponsor, opportunityType, or startActive or endActive are not valid.

Meteor.Error

The newly created docID.

Example
Opportunities.define({ name: 'ATT Hackathon',
                       slug: 'att-hackathon',
                       description: 'Programming challenge at Sacred Hearts Academy, $10,000 prize',
                       opportunityType: 'event',
                       sponsor: 'philipjohnson',
                       ice: { i: 10, c: 0, e: 10},
                       interests: ['software-engineering'],
                     });

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

Parameters:
Name Type Description
docID

The docID of an Opportunity.
Overrides:

View Source api/opportunity/OpportunityCollection.ts, line 331

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

# findDocBySlug(slug) → {Object}

Returns the instance associated with the passed slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

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

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The document representing the instance.

Object

# findIdBySlug(slug) → {String}

Return the docID of the instance associated with this slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

View Source api/base/BaseSlugCollection.ts, line 124

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The docID.

String

# findIdsBySlugs(slugs) → {Array}

Returns a list of docIDs associated with the instances associated with the list of slugs.

Parameters:
Name Type Description
slugs Array

A list or collection of slugs.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 134

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

A list of docIDs.

Array

# findNames(instanceIDs) → {Array}

Returns a list of Opportunity names corresponding to the passed list of Opportunity docIDs.

Parameters:
Name Type Description
instanceIDs

A list of Opportunity docIDs.

View Source api/opportunity/OpportunityCollection.ts, line 322

If any of the instanceIDs cannot be found.

Meteor.Error
Array

# 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

# findRelatedCareerGoals(docIdOrSlug) → {Array.<CareerGoals>}

Returns a list of CareerGoals that have common interests.

Parameters:
Name Type Description
docIdOrSlug string

an opportunity ID or slug.

View Source api/opportunity/OpportunityCollection.ts, line 288

Courses that have common interests.

Array.<CareerGoals>

# findRelatedCourses(docIdOrSlug) → {Array.<Course>}

Returns a list of Courses that have common interests.

Parameters:
Name Type Description
docIdOrSlug string

an opportunity ID or slug.

View Source api/opportunity/OpportunityCollection.ts, line 299

Courses that have common interests.

Array.<Course>

# findRelatedInternships(docIdOrSlug) → {Array.<Internship>}

Returns a list of Internships that have common interests.

Parameters:
Name Type Description
docIdOrSlug string

an opportunity ID or slug.

View Source api/opportunity/OpportunityCollection.ts, line 310

Internships that have common interests.

Array.<Internship>

# findSlugByID(docID) → {String}

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID
Overrides:

View Source api/base/BaseSlugCollection.ts, line 152

If docID is not associated with this entity.

Meteor.Error

The slug name

String

# 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

# getID(instance) → {String}

Returns the docID associated with instance, or throws an error if it cannot be found. If instance is an object with an _id field, then that value is checked to see if it's in the collection. If instance is the value for the username field in this collection, then return that document's ID. If instance is a docID, then it is returned unchanged. If instance is a slug, its corresponding docID is returned.

Parameters:
Name Type Description
instance String

Either a valid docID or a valid slug string.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 24

If instance is not a docID or a slug.

Meteor.Error

The docID associated with instance.

String

# getIDs(instances) → {Array.<String>}

Returns the docIDs associated with instances, or throws an error if any cannot be found. If an instance is a docID, then it is returned unchanged. If a slug, its corresponding docID is returned. If nothing is passed, then an empty array is returned.

Parameters:
Name Type Description
instances Array.<String>

An array of valid docIDs, slugs, or a combination.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 58

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getOpportunityTypeDoc(instanceID) → {Object}

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

Parameters:
Name Type Description
instanceID

The id of the Opportunity.

View Source api/opportunity/OpportunityCollection.ts, line 240

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

# 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

# hasInterest(opportunity, interest) → {boolean}

Returns true if Opportunity has the specified interest.

Parameters:
Name Type Description
opportunity

The opportunity(docID or slug)
interest

The Interest (docID or slug).

View Source api/opportunity/OpportunityCollection.ts, line 278

If opportunity is not a opportunity or interest is not a Interest.

Meteor.Error

True if the opportunity has the associated Interest.

boolean

# hasSlug(slug) → {boolean}

Returns true if the passed slug is associated with an entity of this type.

Parameters:
Name Type Description
slug String

Either the name of a slug or a slugID.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 115

True if the slug is in this collection.

boolean

# isDefined(instance) → {boolean}

Return true if instance is a docID or a slug for this entity.

Parameters:
Name Type Description
instance String

A docID or a slug.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 106

True if instance is a docID or slug for this entity.

boolean

# publish()

Default publication method for entities. It publishes the entire collection.

Overrides:

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

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

Remove the Opportunity.

Parameters:
Name Type Description
instance

The docID or slug of the entity to be removed.
Overrides:

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

If docID is not a Opportunity, or if this Opportunity has any associated opportunity instances.

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

# sort()

Returns the instances sorted by slug string. Instances could be instanceIDs or slug names. Only tested so far with instances being slug names. Hopefully this.findDocBySlug resolves 'this' to the subcollection.

Overrides:

View Source api/base/BaseSlugCollection.ts, line 92

# 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(instance, name, description, opportunityType, sponsor, interests, academicTerms, eventDate, ice, retired, picture)

Update an Opportunity.

Parameters:
Name Type Description
instance

The docID or slug associated with this opportunity.
name

a string (optional).
description

a string (optional).
opportunityType

docID or slug (optional).
sponsor

user in role admin, advisor, or faculty. (optional).
interests

array of slugs or IDs, (optional).
academicTerms

array of slugs or IDs, (optional).
eventDate

a Date (optional). // Deprecated
ice

An ICE object (optional).
retired

boolean (optional).
picture

a string (optional).

View Source api/opportunity/OpportunityCollection.ts, line 122