BaseCollection

api/base. BaseCollection

BaseCollection is an abstract superclass of all RadGrad data model entities.
It is the direct superclass for SlugCollection and SemesterCollection.
Other collection classes are derived from BaseSlugCollection or BaseTypeCollection, which are abstract
classes that inherit from this one.

Constructor

new BaseCollection(type, schema)

Source:

Superclass constructor for all RadGrad entities.
Defines internal fields needed by all entities: _type, _collectionName, _collection, and _schema.

Parameters:
Name Type Description
type String

The name of the entity defined by the subclass.

schema SimpleSchema

The schema for validating fields on insertion to the DB.

Methods

assertAllDefined(names)

Source:

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.

Throws:

If instances is not an array, or if any instance is not in this collection.

Type
Meteor.Error

assertDefined(name)

Source:

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.

Throws:

If not defined.

Type
Meteor.Error

assertValidRoleForMethod(userId)

Source:

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

Throws:

If there is no logged in user, or the user is not an Admin or Advisor.

Type
Meteor.Error

checkIntegrity() → {array}

Source:

Define the default integrity checker for all applications.
Returns an array with a string indicating that this method is not overridden.

Returns:

An array containing a string indicating the use of the default integrity checker.

Type
array

count() → {Number}

Source:

Returns the number of documents in this collection.

Returns:

The number of elements in this collection.

Type
Number

dumpAll() → {Object}

Source:

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.

Returns:

An object representing the contents of this collection.

Type
Object

dumpOne(docID) → {Object}

Source:

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.

Returns:

An object representing this document.

Type
Object

find(selector, options) → {Mongo.Cursor}

Source:
See:

Runs find on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

findDoc(name) → {Object}

Source:

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.

Throws:

If the document cannot be found.

Type
Meteor.Error
Returns:

The document associated with name.

Type
Object

findOne(selector, options) → {Mongo.Cursor}

Source:
See:

Runs findOne on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

getCollectionName() → {string}

Source:

Returns the collection name.

Returns:

The collection name as a string.

Type
string

getPublicationName() → {String}

Source:

Return the publication name.

Returns:

The publication name, as a string.

Type
String

getType() → {String}

Source:

Return the type of this collection.

Returns:

The type, as a string.

Type
String

isDefined(name) → {boolean}

Source:

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.

Returns:

True if name exists in this collection.

Type
boolean

publish()

Source:

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

removeAll()

Source:

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.

Returns:

true

removeIt(name)

Source:

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.

Returns:

true

restoreAll(dumpObjects)

Source:

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}

Source:

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.

Returns:

The docID of the newly created document.

Type
String

subscribe()

Source:

Default subscription method for entities.
It subscribes to the entire collection.

toString() → {String}

Source:

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

Returns:
Type
String

update(selector, modifier)

Source:
See:

Runs a simplified version of update on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

modifier Object

A MongoDB modifier

Returns:

true