=====

API Reference

getHash() ⇒ string

Creates the MD5 hash for this object

Kind: global function
Returns: string - The hash value as string

getHashValue() ⇒ number

Creates the MD5 hash for this object

Kind: global function
Returns: number - The hash value as number

setAllAttributes(attributeValues)

Set all the given attributes in one go. Only the attributes defined for this class will be set

Kind: global function

| Param | Type | Description | | --- | --- | --- | | attributeValues | object | The attributes values to set |

_setParent(propertyName, object)

Set a new parent for this object

Kind: global function

| Param | Type | Description | | --- | --- | --- | | propertyName | string | The name of the reference this object was added to | | object | object | The object this object was added to a reference. If the new object is undefined It means that the parent should be deleted |

_getParent() ⇒ object

Returns the parent of this object. An parent only exists if this object is a conained object.

Kind: global function
Returns: object - The parent of this object

_removeFromParent(propertyName)

Removes this object from its parent, if it has one

Kind: global function

| Param | Type | Description | | --- | --- | --- | | propertyName | string | The name of the reference this object was added to |

_addOpositeReference(propertyName, sourceElement)

Add a reference for this object. If this object is added to an other object, the other object references this. This stores the oposite of a normal attribute.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | propertyName | string | The name of the reference this object was added to | | sourceElement | object | The element this object was added. |

_removeOpositeReference(propertyName, sourceElement)

Referenced objects store all the incomming references to this object. This method will remove an object from this references.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | propertyName | string | The name of the reference this object was added to | | sourceElement | object | The object to be deleted from the incomming references |

getHashValue() ⇒ number

Returns the hash value of this list

Kind: global function
Returns: number - The claculated hashValue as number

_handleAdd()

If an element is added or removed some

Kind: global function

_getElementForObject(element) ⇒ object

Internal helper method. It will return the real object. If the id is given it will retrive the original object for the ID first. Then it will proof that the object is of the given type.

Kind: global function
Returns: object - The real object if it could be found

| Param | Type | Description | | --- | --- | --- | | element | object | The element or element id to be prooved. |

has(element) ⇒ boolean

Returns a boolean value indicating if this list contains the given element or not

Kind: global function
Returns: boolean - True if the element exists in the list

| Param | Type | Description | | --- | --- | --- | | element | object | The element to be searched in the list |

size() ⇒ number

Returns the ammount of stored elements

Kind: global function
Returns: number - The size of the stored elements

add(element)

Adds a new element

Kind: global function

| Param | Type | Description | | --- | --- | --- | | element | object | The element to be added |

remove(element)

Removes the given element from the list if it exists. If the list is not unique it will remove the last one.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | element | object | The element to be removed |

forEach(callback)

The forEach() method executes a provided function once per each value in the Set object, in insertion order.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | Function to execute for each element. |

clear()

clears the list of stored elements

Kind: global function

install

With npm do:

npm install 

license

BSD-2-Clause