base-domain/src/lib/entity.coffee

simple module to help build Domain-Driven Design

'use strict'

BaseModel = require './base-model'

###*
Base model class with "id" column

@class Entity
@extends BaseModel
@module base-domain
###
class Entity extends BaseModel

    ###*
    primary key for the model

    @property id
    @type {String|Number}
    ###
    constructor: ->
        @id = null
        super

    @isEntity: true


    ###*
    check equality

    @method equals
    @param {Entity} entity
    @return {Boolean}
    ###
    equals: (entity) ->

        return false if not @id?

        super(entity) and @id is entity.id


module.exports = Entity