class static
bo.shared.TransferContext

Source: shared/transfer-context.js:30

Provides the context for custom transfer objects.

Property

properties

Methods

getValue(propertyName)
setValue(propertyName, value)

new TransferContext([properties][, getValue][, setValue])

Creates a new transfer context object.

Warning: Transfer context objects are created in models internally. They are intended only to make publicly available the values of model properties for custom transfer objects.

Parameters

Name Type Optional Description

properties

Array of bo.shared.PropertyInfo

Yes

An array of property definitions.

getValue

internal~getValue

Yes

A function that returns the current value of a property.

setValue

internal~setValue

Yes

A function that changes the current value of a property.
Throws

Argument error: The properties must be an array of PropertyInfo objects, or a single PropertyInfo object or null.

Argument error: The getValue argument must be a function.

Argument error: The setValue argument must be a function.

Property

read-only
properties  Array of bo.shared.PropertyInfo

Array of property definitions that may appear on the transfer object.

Methods

getValue(propertyName) → any type

Gets the current value of a model property.

Parameter

Name Type Optional Description

propertyName

string

 

The name of the property.
Throws

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

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

Returns

any type The value of a model property.

setValue(propertyName, value)

Sets the current value of a model property.

Parameters

Name Type Optional Description

propertyName

string

 

The name of the property.

value

any type

 

The new value of the property.
Throws

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

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