BaseEntityPage schema

Level: intermediate

BaseEntityPage is the base schema of the record page. Implemented in the NUI package. This is a view model schema. Learn more about the schema properties in a separate article: Client schema structure. Record page schemas must inherit the BaseEntityPage schema.

Messages

Messages of the base record page

Name	Mode	Direction	Description
UpdateDetail	Address	Publish	Communicates the change details of the record page.
CardModuleResponse	Address	Bidirectional	Communicates the record page change.
CardRendered	Broadcasting	Bidirectional	Communicates the record page processing.
EntityInitialized	Broadcasting	Bidirectional	Communicates the object initialization and sends the object information.
ShowProcessPage	Address	Publish	Displays the process page.

The Terrasoft.core.enums.MessageMode enumeration represents the message modes, and the Terrasoft.core.enums.MessageDirectionType enumeration represents the message directions. Learn more about the MessageMode enumeration in the JS class library. Learn more about the MessageDirectionType enumeration in the JS class library.

Attributes

IsEntityInitialized BOOLEAN

Initializes the entity.

DefaultValues ARRAY

The array of default values for the object.

IsModelItemsEnabled BOOLEAN

The availability flag for model elements.

DetailsConfig CUSTOM_OBJECT

The configuration details.

The Terrasoft.core.enums.DataValueType enumeration represents the attribute types. Learn more about the DataValueType enumeration in the JS class library.

Mixins

EntityResponseValidationMixin Terrasoft.EntityResponseValidationMixin

Checks the server response. If false, generates an error message and launches a dialog.

Methods

init(callback, scope)

Initializes the record page.

Parameters

callback	The callback function.
scope	The method execution context.

saveDetailsInChain(next)

Saves details to a chain.

Parameters

next	The callback function.

getDetailId(detailName)

Returns the detail ID.

Parameters

{String} detailName

The detail name.

loadDetail(config)

Loads the detail. If the detail is loaded, displays it once more.

Parameters

config

The detail configuration.

saveCheckCanEditRight(callback, scope)

Checks whether the user has edit permission.

Parameters

callback	The callback function.
scope	The method execution context.

getLookupDisplayValueQuery(config)

Generates a search query for the display value.

Parameters

config

The detail configuration.

loadLookupDisplayValue(name, value, callback, scope)

Populates the lookup fields.

Parameters

{String} name	The object schema name.
{String} value	The object value.
callback	The callback function.
scope	The method execution context.

canAutoCleanDependentColumns()

Returns true if a business rule can clear the object column.