namespacebo
Source: index.
List of models and helper namespaces.
Namespaces
Methods
- CommandObject(properties, rules, extensions)
- CommandObjectSync(properties, rules, extensions)
- EditableChildCollection(name, itemType)
- EditableChildCollectionSync(name, itemType)
- EditableChildModel(properties, rules, extensions)
- EditableChildModelSync(properties, rules, extensions)
- EditableRootCollection(name, itemType, rules, extensions)
- EditableRootCollectionSync(name, itemType, rules, extensions)
- EditableRootModel(properties, rules, extensions)
- EditableRootModelSync(properties, rules, extensions)
- initialize(cfgPath)
- ReadOnlyChildCollection(name, itemType)
- ReadOnlyChildCollectionSync(name, itemType)
- ReadOnlyChildModel(properties, rules, extensions)
Classes
i18n
I18nError
Namespaces
commonRules
dataAccess
dataTypes
rules
shared
system
Methods
staticCommandObject(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
CommandObjectThe constructor of an asynchronous command object model.
staticCommandObjectSync(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
CommandObjectSyncThe constructor of a synchronous command object model.
staticEditableChildCollection(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 |
|
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
-
EditableChildCollectionThe constructor of an asynchronous editable child collection.
staticEditableChildCollectionSync(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 |
|
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
-
EditableChildCollectionSyncThe constructor of a synchronous editable child collection.
staticEditableChildModel(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
EditableChildModelThe constructor of an asynchronous editable child model.
staticEditableChildModelSync(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
EditableChildModelSyncThe constructor of a synchronous editable child model.
staticEditableRootCollection(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 |
|
The model type of the collection items. |
|
|
rules |
bo.shared.RuleManager |
|
The authorization rules. |
|
extensions |
|
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
-
EditableRootCollectionThe constructor of an asynchronous editable root collection.
staticEditableRootCollectionSync(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 |
|
The model type of the collection items. |
|
|
rules |
bo.shared.RuleManager |
|
The authorization rules. |
|
extensions |
|
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
-
EditableRootCollectionSyncThe constructor of a synchronous editable root collection.
staticEditableRootModel(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
EditableRootModelThe constructor of an asynchronous editable root model.
staticEditableRootModelSync(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
EditableRootModelSyncThe constructor of a synchronous editable root model.
staticinitialize(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 |
staticReadOnlyChildCollection(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 |
|
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
-
ReadOnlyChildCollectionThe constructor of an asynchronous read-only child collection.
staticReadOnlyChildCollectionSync(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 |
|
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
-
ReadOnlyChildCollectionSyncThe constructor of a asynchronous read-only child collection.
staticReadOnlyChildModel(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyChildModelThe constructor of an asynchronous read-only child model.
staticReadOnlyChildModelSync(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyChildModelSyncThe constructor of a synchronous read-only child model.
staticReadOnlyRootCollection(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 |
|
The model type of the collection items. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyRootCollectionThe constructor of an asynchronous read-only root collection.
staticReadOnlyRootCollectionSync(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 |
|
The model type of the collection items. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyRootCollectionSyncThe constructor of a synchronous read-only root collection.
staticReadOnlyRootModel(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyRootModelThe constructor of an asynchronous read-only root model.
staticReadOnlyRootModelSync(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 |
|
The property definitions. |
|
|
rules |
bo.shared.RuleManager |
|
The validation and authorization rules. |
|
extensions |
|
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
-
ReadOnlyRootModelSyncThe constructor of a synchronous read-only root model.