class static
bo.shared.DataPortalContext

Source: shared/data-portal-context.js:34

Provides the context for custom data portal actions.

Properties

connection
dao
isSelfDirty
locale
properties
user

Methods

getValue(propertyName)
setState([connection][, isSelfDirty])
setValue(propertyName, value)

new DataPortalContext(dao, properties[, getValue][, setValue])

Creates a new data context object.

Warning: Data context objects are created in models internally. They are intended only to make publicly available the context for custom data portal actions.

Parameters

Name Type Optional Description

dao

object

 

The data access object of the current model.

properties

Array of bo.shared.PropertyInfo

 

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 dao argument must be an object.

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.

Properties

read-only
connection  object

The connection object for the data source.

read-only
dao  object

The data access object of the current model.

read-only
isSelfDirty  boolean

Indicates whether the current model itself has been changed.

read-only
locale  string

The current locale.

read-only
properties  Array of bo.shared.PropertyInfo

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

read-only
user  bo.system.UserInfo

The current user.

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.

Model error: Cannot read the properties of a collection.

Returns

any type The value of the model property.

setState([connection][, isSelfDirty]) → bo.shared.DataPortalContext

Sets the current state of the model.

Parameters

Name Type Optional Description

connection

object

Yes

The current connection for the data store.

isSelfDirty

boolean

Yes

Indicates whether the current model itself has been changed.
Returns

bo.shared.DataPortalContext The data context object itself.

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.

Model error: Cannot write the properties of a collection.