business-objects v1.1.0 Namespace: bo

List of models and helper namespaces.

Properties:

Name	Type	Description
`commonRules`	namespace	Common rules namespace contains frequently used rules.
`dataAccess`	namespace	Data access namespace contains data access components.
`dataTypes`	namespace	Data types namespace contains data type components and definitions.
`rules`	namespace	Rules namespace contains components of validation and authorization rules.
`shared`	namespace	Shared namespace contains components used by models, collections and other components.
`system`	namespace	System namespace contains general components.
`configuration`	object	Object containing configuration data of the business objects.
`i18n`	function	Internationalization constructor to create new a message localizer object.

Classes

i18n
I18nError

Namespaces

commonRules
dataAccess
dataTypes
rules
shared
system

Methods

<static> CommandObject(properties, rules, extensions) → {CommandObject}

Factory method to create definitions of asynchronous command object models.

Valid child model types are:

 * ReadOnlyChildModel
 * ReadOnlyChildCollection

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The child objects must be ReadOnlyChildModel or ReadOnlyChildCollection instances.

Returns:

The constructor of an asynchronous command object model.

Type: CommandObject

<static> CommandObjectSync(properties, rules, extensions) → {CommandObjectSync}

Factory method to create definitions of synchronous command object models.

Valid child model types are:

 * ReadOnlyChildModelSync
 * ReadOnlyChildCollectionSync

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManagerSync	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The child objects must be ReadOnlyChildModelSync or ReadOnlyChildCollectionSync instances.

Returns:

The constructor of a synchronous command object model.

Type: CommandObjectSync

<static> EditableChildCollection(name, itemType) → {EditableChildCollection}

Factory method to create definitions of asynchronous editable child collections.

Valid collection item types are:

 * EditableChildModel

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	EditableChildModel	The model type of the collection items.

Throws:

Argument error: The collection name must be a non-empty string.
Model error: The item type must be an EditableChildModel.

Returns:

The constructor of an asynchronous editable child collection.

Type: EditableChildCollection

<static> EditableChildCollectionSync(name, itemType) → {EditableChildCollectionSync}

Factory method to create definitions of synchronous editable child collections.

Valid collection item types are:

 * EditableChildModelSync

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	EditableChildModelSync	The model type of the collection items.

Throws:

Argument error: The collection name must be a non-empty string.
Model error: The item type must be an EditableChildModelSync.

Returns:

The constructor of a synchronous editable child collection.

Type: EditableChildCollectionSync

<static> EditableChildModel(properties, rules, extensions) → {EditableChildModel}

Factory method to create definitions of asynchronous editable child models.

Valid child model types are:

 * ReadOnlyChildCollection
 * ReadOnlyChildModel

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The child objects must be EditableChildCollection or EditableChildModel instances.

Returns:

The constructor of an asynchronous editable child model.

Type: EditableChildModel

<static> EditableChildModelSync(properties, rules, extensions) → {EditableChildModelSync}

Factory method to create definitions of synchronous editable child models.

Valid child model types are:

 * EditableChildCollectionSync
 * EditableChildModelSync

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The child objects must be EditableChildCollectionSync or EditableChildModelSync instances.

Returns:

The constructor of a synchronous editable child model.

Type: EditableChildModelSync

<static> EditableRootCollection(name, itemType, rules, extensions) → {EditableRootCollection}

Factory method to create definitions of asynchronous editable root collections.

Valid collection item types are:

 * EditableChildModel

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	EditableChildModel	The model type of the collection items.
`rules`	bo.shared.RuleManager	The authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the collection.

Throws:

Argument error: The collection name must be a non-empty string.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The item type must be an EditableChildModel.

Returns:

The constructor of an asynchronous editable root collection.

Type: EditableRootCollection

<static> EditableRootCollectionSync(name, itemType, rules, extensions) → {EditableRootCollectionSync}

Factory method to create definitions of synchronous editable root collections.

Valid collection item types are:

 * EditableChildModelSync

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	EditableChildModelSync	The model type of the collection items.
`rules`	bo.shared.RuleManager	The authorization rules.
`extensions`	bo.shared.ExtensionManagerSync	The customization of the collection.

Throws:

Argument error: The collection name must be a non-empty string.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The item type must be an EditableChildModelSync.

Returns:

The constructor of a synchronous editable root collection.

Type: EditableRootCollectionSync

<static> EditableRootModel(properties, rules, extensions) → {EditableRootModel}

Factory method to create definitions of asynchronous editable root models.

Valid child model types are:

 * EditableChildCollection
 * EditableChildModel

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The child objects must be EditableChildCollection or EditableChildModel instances.

Returns:

The constructor of an asynchronous editable root model.

Type: EditableRootModel

<static> EditableRootModelSync(properties, rules, extensions) → {EditableRootModelSync}

Factory method to create definitions of synchronous editable root models.

Valid child model types are:

 * EditableChildCollectionSync
 * EditableChildModelSync

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The child objects must be EditableChildCollectionSync or EditableChildModelSync instances.

Returns:

The constructor of a synchronous editable root model.

Type: EditableRootModelSync

<static> initialize(cfgPath)

Initializes the business objects.

Parameters:

Name	Type	Description
`cfgPath`	string	The relative path of the configuration file (.js or .json). E.g. /config/business-objects.json

<static> ReadOnlyChildCollection(name, itemType) → {ReadOnlyChildCollection}

Factory method to create definitions of asynchronous read-only child collections.

Valid collection item types are:

 * ReadOnlyChildModel

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	ReadOnlyChildModel	The model type of the collection items.

Throws:

Argument error: The collection name must be a non-empty string.
Model error: The item type must be an ReadOnlyChildModel.

Returns:

The constructor of an asynchronous read-only child collection.

Type: ReadOnlyChildCollection

<static> ReadOnlyChildCollectionSync(name, itemType) → {ReadOnlyChildCollectionSync}

Factory method to create definitions of synchronous read-only child collections.

Valid collection item types are:

 * ReadOnlyChildModelSync

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	ReadOnlyChildModelSync	The model type of the collection items.

Throws:

Argument error: The collection name must be a non-empty string.
Model error: The item type must be an ReadOnlyChildModelSync.

Returns:

The constructor of a asynchronous read-only child collection.

Type: ReadOnlyChildCollectionSync

<static> ReadOnlyChildModel(properties, rules, extensions) → {ReadOnlyChildModel}

Factory method to create definitions of asynchronous read-only child models.

Valid child model types are:

 * ReadOnlyChildCollection
 * ReadOnlyChildModel

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The child objects must be ReadOnlyChildCollection or ReadOnlyChildModel instances.

Returns:

The constructor of an asynchronous read-only child model.

Type: ReadOnlyChildModel

<static> ReadOnlyChildModelSync(properties, rules, extensions) → {ReadOnlyChildModelSync}

Factory method to create definitions of synchronous read-only child models.

Valid child model types are:

 * ReadOnlyChildCollectionSync
 * ReadOnlyChildModelSync

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The child objects must be ReadOnlyChildCollectionSync or ReadOnlyChildModelSync instances.

Returns:

The constructor of a synchronous read-only child model.

Type: ReadOnlyChildModelSync

<static> ReadOnlyRootCollection(name, itemType, rules, extensions) → {ReadOnlyRootCollection}

Factory method to create definitions of asynchronous read-only root collections.

Valid collection item types are:

 * ReadOnlyChildModel

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	ReadOnlyChildModel	The model type of the collection items.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the collection.

Throws:

Argument error: The collection name must be a non-empty string.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The item type must be an ReadOnlyChildModel.

Returns:

The constructor of an asynchronous read-only root collection.

Type: ReadOnlyRootCollection

<static> ReadOnlyRootCollectionSync(name, itemType, rules, extensions) → {ReadOnlyRootCollectionSync}

Factory method to create definitions of synchronous read-only root collections.

Valid collection item types are:

 * ReadOnlyChildModelSync

Parameters:

Name	Type	Description
`name`	string	The name of the collection.
`itemType`	ReadOnlyChildModelSync	The model type of the collection items.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManagerSync	The customization of the collection.

Throws:

Argument error: The collection name must be a non-empty string.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The item type must be a ReadOnlyChildModelSync.

Returns:

The constructor of a synchronous read-only root collection.

Type: ReadOnlyRootCollectionSync

<static> ReadOnlyRootModel(properties, rules, extensions) → {ReadOnlyRootModel}

Factory method to create definitions of asynchronous read-only root models.

Valid child model types are:

 * ReadOnlyChildCollection
 * ReadOnlyChildModel

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManager object.
Model error: The child objects must be ReadOnlyChildCollection or ReadOnlyChildModel instances.

Returns:

The constructor of an asynchronous read-only root model.

Type: ReadOnlyRootModel

<static> ReadOnlyRootModelSync(properties, rules, extensions) → {ReadOnlyRootModelSync}

Factory method to create definitions of synchronous read-only root models.

Valid child model types are:

 * ReadOnlyChildCollectionSync
 * ReadOnlyChildModelSync

Parameters:

Name	Type	Description
`properties`	bo.shared.PropertyManager	The property definitions.
`rules`	bo.shared.RuleManager	The validation and authorization rules.
`extensions`	bo.shared.ExtensionManager	The customization of the model.

Throws:

Argument error: The properties must be a PropertyManager object.
Argument error: The rules must be a RuleManager object.
Argument error: The extensions must be a ExtensionManagerSync object.
Model error: The child objects must be ReadOnlyChildCollectionSync or ReadOnlyChildModelSync instances.

Returns:

The constructor of a synchronous read-only root model.

Type: ReadOnlyRootModelSync