Class

DeveloperCollection

api/user~DeveloperCollection()

DeveloperCollection, collection of HACC-Hui developers.

Constructor

# new DeveloperCollection()

View Source api/user/DeveloperCollection.js, line 24

Extends

Methods

# 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.js, line 168

If not defined.

Meteor.Error

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

View Source api/base/BaseCollection.js, line 35

The number of elements in this collection.

Number

# define(username, firstName, lastName, demographicLevel, lookingForTeam, challenges, interests, skills, tools, linkedIn, gitHub, website, aboutMe, isCompliant) → {Object|undefined}

Creates a new developer.

Parameters:
Name Type Description
username String

the developer's username.

firstName String

the developer's first name.

lastName String

the developer's last name.

demographicLevel String

the developer's demographic level.

lookingForTeam Boolean

if the developer is looking for a team.

challenges Array.<String>

the challenges the developer is interested in.

interests Array.<String>

the developer's interests.

skills Array.<String>

the developer's skills.

tools Array.<String>

the tools the developer is interested in.

linkedIn String

the developer's LinkedIn page (optional).

gitHub String

the developer's GitHub page (optional).

website String

the developer's website (optional).

aboutMe String

a short description.

isCompliant Boolean

is the developer compliant.

Overrides:

View Source api/user/DeveloperCollection.js, line 59

Object | undefined

# 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.js, line 201

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

Returns an object representing the developer.

Parameters:
Name Type Description
docID String

the ID of the developer.

Overrides:

View Source api/user/DeveloperCollection.js, line 176

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.js, line 75

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.js, line 86

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.js, line 130

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.js, line 110

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.js, line 120

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

Meteor.Error

A list of docIDs.

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.js, line 111

Mongo.Cursor

# findSlugByID(docID) → {String}

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID

Overrides:

View Source api/base/BaseSlugCollection.js, line 140

If docID is not associated with this entity.

Meteor.Error

The slug name

String

# getCollectionName() → {string}

Returns the collection name.

Overrides:

View Source api/base/BaseCollection.js, line 136

The collection name as a string.

string

# 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.js, line 25

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.js, line 55

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getPublicationName() → {String}

Return the publication name.

Overrides:

View Source api/base/BaseCollection.js, line 128

The publication name, as a string.

String

# getSchema() → {SimpleSchema}

Returns the schema attached to this collection.

Overrides:

View Source api/base/BaseCollection.js, line 144

SimpleSchema

# getType() → {String}

Return the type of this collection.

Overrides:

View Source api/base/BaseCollection.js, line 120

The type, as a string.

String

# hasProfile(user)

Returns non-null if the user has a profile in this collection.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

View Source api/user/DeveloperCollection.js, line 203

If user is not a valid user.

Meteor.Error

The profile document if the profile exists, or null if not found.

# 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.js, line 100

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.js, line 91

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

boolean

# publish()

Default publication method for entities. It publishes the entire collection. This should be overridden in subclasses.

Overrides:

View Source api/base/BaseCollection.js, line 178

# removeIt(docID)

Removes the developer.

Parameters:
Name Type Description
docID String

the ID of the developer.

Overrides:

View Source api/user/DeveloperCollection.js, line 159

if the docID is not defined.

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.js, line 243

# 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.js, line 232

The docID of the newly created document.

String

# subscribe()

Default subscription method for entities. It subscribes to the entire collection. Should be overridden in subclass

Overrides:

View Source api/base/BaseCollection.js, line 188

# update(docID, firstName, lastName, demographicLevel, lookingForTeam, challenges, interests, skills, tools, linkedIn, gitHub, website, aboutMe, isCompliant)

Updates the developer.

Parameters:
Name Type Description
docID String

the ID of the developer to update.

firstName String

the new first name (optional).

lastName String

the new last name (optional).

demographicLevel String

the new demographic level (optional).

lookingForTeam Boolean

the new looking for team value (optional).

challenges Array.<String>

the new challenges (optional).

interests Array.<String>

the new interests (optional).

skills Array.<String>

the new skills (optional).

tools Array.<String>

the new tools (optional).

linkedIn String

the new LinkedIn page (optional).

gitHub String

the new GitHub page (optional).

website String

the new website (optional).

aboutMe String

the new short description (optional).

isCompliant Boolean

the new is compliant value (optional).

Overrides:

View Source api/user/DeveloperCollection.js, line 101