LetterModel  - AS3 Asset Composer

The consolidated list of variable and field assignments of this letter.

此属性可用作数据绑定的源。修改此属性后，将调度 assignmentsChange 事件。

The typed DataDictionary object being used by this module. Assigning a value to this property updated the dataDictionaryName as well but not the other way round.

此属性可用作数据绑定的源。修改此属性后，将调度 ddChange 事件。

The name of the data dictionary being used by this module. Merely setting this property wouldn't cause the dataDictionary to be retrieved. If the dataDictionary needs to be updated, setDataDictionaryName() method must be used instead.

此属性可用作数据绑定的源。修改此属性后，将调度 ddNameChange 事件。

相关 API 元素

The infrastructure service for data dictionary mainly used internally for fetching data dictionary objects.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

Returns the list of fields in the base layout and all the container layouts.

此属性可用作数据绑定的源。修改此属性后，将调度 fieldAssignmentsChange 事件。

The domain object of the layout associated with this letter.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

The list of data modules being referred in this letter.

The postprocess to be executed.

The letter service instance that is used for saving/retrieving the letter on the server. This service is internally invoked by the LetterModel class for performing CRUD operations.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

The list of target area assignments in this Letter.

此属性可用作数据绑定的源。修改此属性后，将调度 targetAreaAssignmentsChange 事件。

The test data file that supplies the preview data.

Creates a copy of the domain object.

Note that this is different than cloning via ObjectUtil.copy() since a "copied" object needs to be saved via a specific server api.

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development. In some cases, the value objects could be shallow; for instance when obtained via Data Services. The complete value object could be requested by passing the fetchFromServer flag as true. In that case, the value object is obtained from the server via remoting call and the domain object shapes accordingly as the server response arrives.

参数

Fetches the data dictionary corresponding to the name specified.

Returns the target area assignment domain object for the passed target area.

参数

Returns the list of variables being referred in this letter. This is a consolidated list of all the variables from all the referred modules.

Indicates whether the data dictionary defined for this letter has been referred in any of the assignments.

The function indicates whether data dictionary is referenced in the nested layout.

参数

Resets all the assignment lists in this Letter.

参数

Saves the underlying value object on the server.

Under the hood, separate calls are required for creating a new asset and copying or copying an existing one.

The save() method internally invokes the relevant server calls on the basis of its current state. The domain object constructed from the createFromVO() method would invoke the "update" api, the domain object starightaway instantiated on the client would inoke the "create" module api and the domain object obtained by the copy() method would internally call "copy api".

Invoking the save() implicitly invokes the validate() method to perform the necessary client side validations. Only when the client side validations are successful, is the actual save() call made. A save() method wouldn't proceed past the validation stage unless the object's state is made valid via user input or otherwise.

Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.

参数

This method lets you inject a custom implementation of the infrastructure data dictionary service. By default, the class DataDictionaryRegistryServiceImpl is used as the infrastructure service.

参数

Sets the layout for this letter.

参数

This method lets you inject a custom implementation of the infrastructure letter service. By default, the class LetterServiceDelegate is used as the infrastructure service.

参数

Dispatched when the letter has been completely fetched from the server.

Dispatched when a module assignment is added to any of the target area assignments.

Dispatched when a module assignment is removed from any of the target area assignments.

Dispatched when the letter is successfully saved.

The saveComplete event is dispatched when the domain object has been successfully saved on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

Dispatched when a fault occurs while saving the letter.

The saveFault event is dispatched when the server reports an error while saving the asset on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

When this event is dispatched, the fault property contains the fault object encapsulating the error sent by the server. The fault property can be used to determine the faultCode and show an error message accordingly.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

Dispatched when the current letter is requested for save. This event, being bubbling in nature, can be leveraged by the UI to display a progress bar or animation to indicate the save progress.

The saving event is dispatched when the save() method has been called on the domain object. This event is dispatched before any server api is invoked but after the domain client validations are complete. This is because the actual save starts once the client validations are complete.

This event can be used to start a UI animation indicating "save in progress".