/**
* @fileOverview Describes the interface of filtering entity
* collections.
*/
/**
* @mixin
* @summary A filter interface which selects some elements from an
* entity collection.
* @description The Filter object is never instantiated; it is only a
* template on what objects are used for
* [filtering entities]{@link API3.EntityCollection.filter}.
*/
API3.Filter = function () {
/**
* @todo Describe the dynamicProperties concept
* @type Array.<String>
*/
this.dynamicProperties = [];
};
/**
* @summary The actual filter function to select entities.
* @param ent {API3.Entity} An entity to test whether it shall belong
* to a derived/filtered collection.
* @return {Boolean} <code>true</code> iff the tested entity currently
* matches the filter criterion and shall be
* included in the derived collection.
*/
API3.Filter.prototype.func = function (ent) {
// Not implemented in interface/mixin
};
// -------------------------------------------------------------------
// End of file
// -------------------------------------------------------------------