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. |
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 empty array to indicate no integrity checking.
An empty array.
# 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.
The number of non-retired elements in this collection.
# define(obj)
Define documents for the collection.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object | the document. |
Meteor.Error since shouldn't call this method on the base class.
# 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 definition of docID in a format appropriate to the restoreOne function. Must be overridden by each collection.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
A docID from this collection. |
An object representing this document.
# 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.
# 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:
# getCollection() → {Mongo.Collection}
Returns the Mongo collection.
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.
the define method's parameter.
# getLastUpdateTimestamp(key)
Returns a date object corresponding to the passed key, which should be one of the lastUpdate fields in YYYY-MM-DD-HH-mm-ss.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
Should be PublicStats.opportunitiesUpdateTime etc. |
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# getPublicStat(key) → {string}
Returns the value for the given key, or empty string if invalid key.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string |
# getUpdateSchema() → {SimpleSchema}
Returns a schema for the update method's second parameter.
.
# 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. |
True if name exists in this collection.
# 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(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. |
true
# 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.