class static

bo.shared.PropertyManager

Parameters

read-only

name  string

The name of the business object model.

add(property)

Adds a new property to the business object model.

Throws

Argument error: The property must be PropertyInfo object.

Model error: Cannot change the definition after creation.

childCount() → Number

Gets the count of the child models and collections of the current model.

Returns

Number The count of the child properties.

children() → Array of bo.shared.PropertyInfo

Gets the child models and collections of the current model.

Returns

Array of bo.shared.PropertyInfo - The array of the child properties.

contains(property) → boolean

Determines whether a property belongs to the business object model.

Throws

Argument error: The property must be PropertyInfo object.

Returns

boolean True if the model contains the property, otherwise false.

create(name, type[, flags]) → bo.shared.PropertyInfo

Creates a new property for the business object model.

The data type can be any one from the bo.dataTypes namespace or a custom data type based on DataType object, or can be any business object model or collection defined by the model types available in the bo namespace (i.e. models based on ModelBase or {@link bo.CollectionBase CollectionBase} objects).

The flags parameter is ignored when data type is a model or collection.

Throws

Argument error: The name must be a non-empty string.

Argument error: The type must be a data type, a model or a collection.

Argument error: The flags must be PropertyFlag items.

Model error: Cannot change the definition after creation.

Returns

bo.shared.PropertyInfo The definition of the property.

filter(callback) → Array of bo.shared.PropertyInfo

Creates a new array with all properties that pass the test implemented by the provided function.

Returns

Array of bo.shared.PropertyInfo A new array with all properties that passed the test.

forEach(callback)

Executes the provided function once per property definition.

getByName(name[, message][, ...messageParams]) → bo.shared.PropertyInfo

Gets the property with the given name.

Throws

Argument error: The name must be a non-empty string.

Argument error: The business object has no property with the given name.

Returns

bo.shared.PropertyInfo The requested property definition.

protected

getKey(getPropertyValue) → any type

Gets the key of the current model.

If the model has no key properties, the method returns the data transfer object, If the model has one key property, then it returns the current value of the that property. If the model has more key properties, an object will be returned whose properties will hold the current values of the key properties.

Throws

Argument error: The getPropertyValue argument must be a function.

Returns

any type The key value of the model.

protected

keyEquals(data, getPropertyValue) → boolean

Determines that the passed data contains current values of the model key.

Throws

Argument error: The data argument must be an object.

Argument error: The getPropertyValue argument must be a function.

Returns

boolean True when the values are equal, false otherwise.

map(callback) → Array

Creates a new array with the results of calling a provided function on every element of the model properties.

Returns

Array A new array with items produced by the function.

toArray() → Array of bo.shared.PropertyInfo

Gets the property definitions of the business object model as an array.

Returns

Array of bo.shared.PropertyInfo The array of model properties.

verifyChildTypes(allowedTypes)

Verifies the model types of child models and freezes properties of the model.

Throws

Argument error: The allowed types must be an array of string values or a single string value.

Model error: The type of a model property should be an allowed type.