Class

BaseTypeCollection

api/base.BaseTypeCollection()

BaseType is an abstract superclass that factors out common code for the "type" entities: OpportunityType and TagType.

Constructor

# new BaseTypeCollection()

Creates the BaseType collection.

View Source api/base/BaseTypeCollection.ts, line 12

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)

Default implementation of assertValidRoleForMethod. Asserts that userId is logged in as an Admin 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/base/BaseCollection.ts, line 280

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 slugID. This is the default integrity checker for all BaseTypeCollection subclasses.

Overrides:

View Source api/base/BaseTypeCollection.ts, line 166

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 BaseType with its name, slug, and description.

Parameters:
Name Type Description
description Object

Object with keys name, slug, and description. Slug must be globally unique and previously undefined.

Overrides:

View Source api/base/BaseTypeCollection.ts, line 42

If the slug already exists.

Meteor.Error

The newly created docID.

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

Parameters:
Name Type Description
docID

The docID of a "Type".

Overrides:

View Source api/base/BaseTypeCollection.ts, line 180

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 document associated with the passed slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).

View Source api/base/BaseTypeCollection.ts, line 126

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

Meteor.Error

The document.

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

View Source api/base/BaseTypeCollection.ts, line 146

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

Meteor.Error

The docID.

String

# 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

# findSlugByID(docID) → {String}

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID

View Source api/base/BaseTypeCollection.ts, line 136

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 a docID, then it is returned unchanged. If instance is a slug, its corresponding docID is returned. If instance is an object with an _id field, then that value is checked to see if it's in the collection.

Parameters:
Name Type Description
instance String

Either a valid docID or a valid slug string.

View Source api/base/BaseTypeCollection.ts, line 56

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.

Parameters:
Name Type Description
instances Array.<String>

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

View Source api/base/BaseTypeCollection.ts, line 77

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getNameFromID(docID)

Returns the name associated with this docID.

Parameters:
Name Type Description
docID

The docID for this "type".

View Source api/base/BaseTypeCollection.ts, line 155

If the passed docID is not valid.

Meteor.Error

The name of this "type" instance.

# 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

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

View Source api/base/BaseTypeCollection.ts, line 116

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/BaseTypeCollection.ts, line 108

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)

Removes the passed instance from its collection. Also removes the associated Slug. Note that prior to calling this method, the subclass should do additional checks to see if any dependent objects have been deleted.

Parameters:
Name Type Description
instance String

A docID or slug representing the instance.

Overrides:

View Source api/base/BaseTypeCollection.ts, line 95

If the instance (and its associated slug) cannot be found.

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() → {String}

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

Overrides:

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

String