Classes

Namespaces

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 Optional 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

CommandObject The constructor of an asynchronous command object model.

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 Optional 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

CommandObjectSync The constructor of a synchronous command object model.

static
EditableChildCollection(name, itemType) → EditableChildCollection

Factory method to create definitions of asynchronous editable child collections.

Valid collection item types are:

 * EditableChildModel

Parameters

Name Type Optional 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

EditableChildCollection The constructor of an asynchronous editable child collection.

static
EditableChildCollectionSync(name, itemType) → EditableChildCollectionSync

Factory method to create definitions of synchronous editable child collections.

Valid collection item types are:

 * EditableChildModelSync

Parameters

Name Type Optional 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

EditableChildCollectionSync The constructor of a synchronous editable child collection.

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 Optional 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

EditableChildModel The constructor of an asynchronous editable child model.

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 Optional 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

EditableChildModelSync The constructor of a synchronous editable child model.

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 Optional 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

EditableRootCollection The constructor of an asynchronous editable root collection.

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 Optional 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

EditableRootCollectionSync The constructor of a synchronous editable root collection.

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 Optional 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

EditableRootModel The constructor of an asynchronous editable root model.

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 Optional 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

EditableRootModelSync The constructor of a synchronous editable root model.

static
initialize(cfgPath)

Initializes the business objects.

Parameter

Name Type Optional 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 Optional 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

ReadOnlyChildCollection The constructor of an asynchronous read-only child collection.

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 Optional 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

ReadOnlyChildCollectionSync The constructor of a asynchronous read-only child collection.

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 Optional 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

ReadOnlyChildModel The constructor of an asynchronous read-only child model.

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 Optional 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

ReadOnlyChildModelSync The constructor of a synchronous read-only child model.

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 Optional 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

ReadOnlyRootCollection The constructor of an asynchronous read-only root collection.

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 Optional 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

ReadOnlyRootCollectionSync The constructor of a synchronous read-only root collection.

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 Optional 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

ReadOnlyRootModel The constructor of an asynchronous read-only root model.

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 Optional 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

ReadOnlyRootModelSync The constructor of a synchronous read-only root model.