Specializes Blueprint

Properties

binder :Property source

Inherited From:	Blueprint#binder
Default Value:	null

blueprintInstanceModule source

This is used for references only so that we can reload referenced blueprints.

Inherited From:	Blueprint#blueprintInstanceModule

customPrototype :boolean source

Defines whether the blueprint should use custom prototype for new instances.

Is true if the blueprint needs to require a custom prototype for creating new instances, false if new instance are generic prototypes.

Inherited From:	Blueprint#customPrototype
Default Value:	false

evaluateRules source

Evaluates the rules based on the object and the properties.

Inherited From:	Blueprint#evaluateRules

eventBlueprints :?Array.<EventBlueprint> source

Inherited From:	Blueprint#eventBlueprints

exportName :string source

The name of the export this blueprint is for.

identifier :string source

The identifier is the same as the name and is used to make the serialization of a blueprint humane.

Inherited From:	Blueprint#identifier
Default Value:	`this.name`

module :ModuleReference source

A reference to the module that this blueprint is for.

name source

Inherited From:	Blueprint#name

newAssociationBlueprint source

Return a new association blueprint. Note: This is the canonical way of creating new association blueprint in order to enable subclassing.

Inherited From:	Blueprint#newAssociationBlueprint

newDerivedPropertyBlueprint source

Return a new derived property blueprint. Note: This is the canonical way of creating new derived property blueprint in order to enable subclassing.

Inherited From:	Blueprint#newDerivedPropertyBlueprint

newEventBlueprint source

Return a new event blueprint. Note: This is the canonical way of creating new event blueprint in order to enable subclassing.

Inherited From:	Blueprint#newEventBlueprint

newPropertyBlueprint source

Return a new property blueprint.

Note: This is the canonical way of creating new property blueprint in order to enable subclassing.

Inherited From:	Blueprint#newPropertyBlueprint

ObjectProperty :ObjectProperty source

Return the blueprint object property for this blueprint.

This will return the default if none is declared.

Inherited From:	Blueprint#ObjectProperty

parent :BlueprintReference source

Blueprint parent

Inherited From:	Blueprint#parent

propertyBlueprintGroupForName source

Returns the group associated with that name

Inherited From:	Blueprint#propertyBlueprintGroupForName

propertyBlueprintGroups :Array.<PropertyBlueprint> source

List of properties blueprint groups names

Inherited From:	Blueprint#propertyBlueprintGroups

propertyBlueprints :Array.<PropertyBlueprint> source

Inherited From:	Blueprint#propertyBlueprints

propertyValidationRuleForName source

Returns the properties validation rule for that name

Inherited From:	Blueprint#propertyValidationRuleForName

propertyValidationRules source

Gets the list of properties validation rules.

Inherited From:	Blueprint#propertyValidationRules

Methods

getBlueprintWithModuleId(blueprint, require) <constructor> source

Gets a blueprint from a serialized file at the given module id.

Parameters:

Name	Type	Description
blueprint	string	module id
require	function	function

addEventBlueprint(property) → {PropertyBlueprint} source

Add a new property blueprint to this blueprint.

If that property blueprint was associated with another blueprint it will be removed first.

Parameters:

Name	Type	Description
property	string	blueprint The property blueprint to be added.

Inherited From:	Blueprint#addEventBlueprint

Returns: PropertyBlueprint

addEventBlueprintNamed(name) → {EventBlueprint} source

Convenience to add an event blueprint.

Parameters:

Name	Type	Description
name	string

Inherited From:	Blueprint#addEventBlueprintNamed

Returns: EventBlueprint

addPropertyBlueprint(property) source

Add a new property blueprint to this blueprint.

If that property blueprint was associated with another blueprint it will be removed first.

Parameters:

Name	Type	Description
property	PropertyBlueprint	blueprint The property blueprint to be added.

Inherited From:	Blueprint#addPropertyBlueprint

Returns:

the property blueprint

addPropertyBlueprintGroupNamed(name) → {Array.<PropertyBlueprint>} source

Add a new property blueprint group.

Parameters:

Name	Type	Description
name	string	of the group

Inherited From:	Blueprint#addPropertyBlueprintGroupNamed

Returns: Array.<PropertyBlueprint>

new property blueprint group

addPropertyBlueprintToGroupNamed(property, name) → {Array.<PropertyBlueprint>} source

Adds a property blueprint to the group name. if the group does not exist creates it.

Parameters:

Name	Type	Description
property	string	to add
name	string	of the group

Inherited From:	Blueprint#addPropertyBlueprintToGroupNamed

Returns: Array.<PropertyBlueprint>

property blueprint group

addPropertyValidationRule(name) → {PropertyDescription} source

Add a new properties validation rule .

Parameters:

Name	Type	Description
name	string	of the rule

Inherited From:	Blueprint#addPropertyValidationRule

Returns: PropertyDescription

new properties validation rule

addToManyAssociationBlueprintNamed(name, inverse) → {AssociationBlueprint} source

Convenience to add an property blueprint to many relationships.

Parameters:

Name	Type	Description
name	string	TODO
inverse	string	TODO

Inherited From:	Blueprint#addToManyAssociationBlueprintNamed

Returns: AssociationBlueprint

addToManyPropertyBlueprintNamed(name) → {PropertyBlueprint} source

Convenience to add many property blueprints.

Parameters:

Name	Type	Description
name	string	Add to many property blueprints

Inherited From:	Blueprint#addToManyPropertyBlueprintNamed

Returns: PropertyBlueprint

addToOneAssociationBlueprintNamed(name, inverse) → {AssociationBlueprint} source

Convenience to add an property blueprint to one relationship.

Parameters:

Name	Type	Description
name	string
inverse	string

Inherited From:	Blueprint#addToOneAssociationBlueprintNamed

Returns: AssociationBlueprint

addToOnePropertyBlueprintNamed(name) → {PropertyBlueprint} source

Convenience to add one property blueprint.

Parameters:

Name	Type	Description
name	string	Add to one property blueprint

Inherited From:	Blueprint#addToOnePropertyBlueprintNamed

Returns: PropertyBlueprint

create(prototype, propertyDescriptor) source

This is the canonical way of creating managed objects prototypes.

Newly created prototype will be blessed with all the required properties to be well behaved.

Parameters:

Name	Type	Description
prototype	Object
propertyDescriptor	Object

Inherited From:	Blueprint#create

Returns:

newPrototype

eventBlueprintForName(name) → {EventBlueprint} source

Parameters:

Name	Type	Description
name	string

Inherited From:	Blueprint#eventBlueprintForName

Returns: EventBlueprint

initWithModuleAndExportName(module, name) source

Parameters:

Name	Type	Description
module	ModuleReference
name	string

Returns:

this

initWithName(name) source

Parameters:

Name	Type	Description
name	string	The name of the blueprint

Inherited From:	Blueprint#initWithName

Returns:

itself

newInstance() source

Create a new instance of the target prototype for the blueprint.

Inherited From:	Blueprint#newInstance

Returns:

new instance

newInstancePrototype() source

Returns the target prototype for this blueprint.

Note: This method uses the customPrototype property to determine if it needs to require a custom prototype or create a default prototype.

Inherited From:	Blueprint#newInstancePrototype

Returns:

new prototype

propertyBlueprintForName(name) → {PropertyBlueprint} source

Parameters:

Name	Type	Description
name	string

Inherited From:	Blueprint#propertyBlueprintForName

Returns: PropertyBlueprint

removeEventBlueprint(property) → {PropertyBlueprint} source

Removes an property blueprint from the property blueprint list of this blueprint.

Parameters:

Name	Type	Description
property	Object	blueprint The property blueprint to be removed.

Inherited From:	Blueprint#removeEventBlueprint

Returns: PropertyBlueprint

removePropertyBlueprint(property) source

Removes a property blueprint from the property blueprint list of this blueprint.

Parameters:

Name	Type	Description
property	PropertyBlueprint	blueprint The property blueprint to be removed.

Inherited From:	Blueprint#removePropertyBlueprint

Returns:

the same property blueprint

removePropertyBlueprintFromGroupNamed(name, name) → {Array.<PropertyBlueprint>} source

Removes a property blueprint from the group name.

Parameters:

Name	Type	Description
name	string	of the property
name	string	of the group

Inherited From:	Blueprint#removePropertyBlueprintFromGroupNamed

Returns: Array.<PropertyBlueprint>

property blueprint group

removePropertyBlueprintGroupNamed(name) → {Array.<PropertyBlueprint>} source

Remove the property blueprint group.

Parameters:

Name	Type	Description
name	string	of the group to remove

Inherited From:	Blueprint#removePropertyBlueprintGroupNamed

Returns: Array.<PropertyBlueprint>

removed property blueprint group

removePropertyValidationRule(name) → {PropertyDescription} source

Remove the properties validation rule for the name.

Parameters:

Name	Type	Description
name	string	of the rule

Inherited From:	Blueprint#removePropertyValidationRule

Returns: PropertyDescription

removed properties validation rule

Generated from v0.14.14