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:
If instances is not an array, or if any instance is not in this collection.
# 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:
If not defined.
# 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:
If there is no logged in user, or the user is not an Admin or Advisor.
# 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:
A (possibly empty) array of strings indicating integrity issues.
# count() → {Number}
Returns the number of documents in this collection.
The number of elements in this collection.
# countNonRetired() → {Number}
Returns the number of non-retired documents in this collection.
- Overrides:
The number of non-retired elements in this collection.
# define(description)
Defines a new OpportunityType 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. |
If the slug already exists.
The newly created docID.
Example
OpportunityTypes.define({ name: 'Research', slug: 'research', description: 'A research project.' });# 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.
An object representing the contents of this collection.
# 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". |
An object representing the definition of docID.
# 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:
# 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. |
If the document cannot be found.
The document associated with name.
# findDocBySlug(slug) → {Object}
Returns the document associated with the passed slug.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | The slug (string or docID). |
- Overrides:
If the slug cannot be found, or is not associated with an instance in this collection.
The document.
# 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:
If the slug cannot be found, or is not associated with an instance in this collection.
The docID.
# 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:
non-retired documents.
# 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:
# findSlugByID(docID) → {String}
Returns the slug name associated with this docID.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID |
- Overrides:
If docID is not associated with this entity.
The slug name
# getCollection() → {Mongo.Collection}
Returns the Mongo collection.
- Overrides:
The collection.
# getCollectionName() → {string}
Returns the collection name.
- Overrides:
The collection name as a string.
# getCollectionSchema() → {SimpleSchema}
Returns the schema applied to the collection.
- Overrides:
.
# getDefineSchema() → {SimpleSchema}
Returns a schema for the define method's parameter.
- Overrides:
the define method's parameter.
# 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. |
If instance is not a docID or a slug.
The docID associated with instance.
# 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. |
If any instance is not a docID or a slug.
The docIDs associated with instances.
# getNameFromID(docID)
Returns the name associated with this docID.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID for this "type". |
- Overrides:
If the passed docID is not valid.
The name of this "type" instance.
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# getUpdateSchema() → {SimpleSchema}
Returns a schema for the update method's second parameter.
- Overrides:
.
# 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. |
True if the slug is in this collection.
# 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:
True if instance is a docID or slug for this entity.
# publish()
Default publication method for entities. It publishes the entire collection.
# 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.
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. |
If the instance (and its associated slug) cannot be found.
# 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. |
# 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. |
The docID of the newly created document.
# subscribe()
Default subscription method for entities. It subscribes to the entire collection.
# toString() → {String}
Returns a string representing all of the documents in this collection.
# update(docID, name, description)
Update an OpportunityType.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
the docID to be updated. |
|
name |
the new name (optional). |
|
description |
the new description (optional). |
If docID is not defined.