Class: EditableChildModelSync

 * EditableChildCollectionSync
 * EditableRootModelSync
 * EditableChildModelSync

Extends

• ModelBase

Members

<readonly> $modelName :string

The name of the model. However, it can be hidden by a model property with the same name.

Type:

• string

Methods

<protected, static> create(parent, eventHandlers) → {EditableChildModelSync}

Creates a new editable business object instance.
This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
parent	object		The parent business object.
eventHandlers	bo.shared.EventHandlerList	<optional>	The event handlers of the instance.

Throws:

• Authorization error: The user has no permission to execute the action.
• Data portal error: Creating the business object has failed.

Returns:

A new editable business object.

Type

EditableChildModelSync

<protected, static> load(parent, data, eventHandlers) → {EditableChildModelSync}

Initializes an editable business object width data retrieved from the repository.
This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
parent	object		The parent business object.
data	object		The data to load into the business object.
eventHandlers	bo.shared.EventHandlerList	<optional>	The event handlers of the instance.

Throws:

Authorization error: The user has no permission to execute the action.

Returns:

The required editable business object.

Type

EditableChildModelSync

<protected> checkRules()

Executes all the validation rules of the business object, including the ones of its child objects.

This method is called by the parent object.

<protected> childHasChanged()

Notes that a child object has changed.
This method is called by child objects.

<protected> create()

Initializes a newly created business object.
This method is called by the parent object.

<protected> fetch(data, method)

Initializes a business object with data retrieved from the repository.
This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
data	object	<optional>	The data to load into the business object.
method	string	<optional>	An alternative fetch method to check for permission.

fromCto(cto)

Rebuilds the business object from a plain object sent by the client.
This method is usually called by the parent object.

Parameters:

Name	Type	Description
cto	object	The client transfer object.

<protected> getBrokenRules(namespace) → {bo.rules.BrokenRulesOutput}

Gets the broken rules of the business object.

This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
namespace	string	<optional>	The namespace of the message keys when messages are localizable.

Returns:

The broken rules of the business object.

Type

bo.rules.BrokenRulesOutput

getModelState() → {string}

Gets the state of the model. Valid states are: pristine, created, changed, markedForRemoval and removed.

Returns:

The state of the model.

Type

string

isDeleted() → {boolean}

Indicates whether the business object will be deleted from the repository, i.e. its state is markedForRemoval.

Returns:

True when the business object will be deleted, otherwise false.

Type

boolean

isDirty() → {boolean}

Indicates whether the business object itself or any of its child objects differs the one that is stored in the repository, i.e. its state is created, changed or markedForRemoval.

Returns:

True when the business object has been changed, otherwise false.

Type

boolean

isNew() → {boolean}

Indicates whether the business object has been created newly and not has been yet saved, i.e. its state is created.

Returns:

True when the business object is new, otherwise false.

Type

boolean

isSelfDirty() → {boolean}

Indicates whether the business object itself, ignoring its child objects, differs the one that is stored in the repository.

Returns:

True when the business object itself has been changed, otherwise false.

Type

boolean

<protected> isValid() → {boolean}

Indicates whether all the validation rules of the business object, including the ones of its child objects, succeeds. A valid business object may have broken rules with severity of success, information and warning.

This method is called by the parent object.

Returns:

True when the business object is valid, otherwise false.

Type

boolean

<protected> keyEquals(data, getPropertyValue) → {boolean}

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

Parameters:

Name	Type	Description
data	object	Data object whose properties can contain the values of the model key.
getPropertyValue	internal~getValue	A function that returns the current value of the given property.

Returns:

True when the values are equal, false otherwise.

Type

boolean

remove()

Marks the business object to be deleted from the repository on next save.

<protected> save(connection) → {EditableChildModelSync}

Saves the changes of the business object to the repository.
This method is called by the parent object.

Parameters:

Name	Type	Description
connection	object	The connection data.

Returns:

The business object with the new state after the save.

Type

EditableChildModelSync

toCto() → {object}

Transforms the business object to a plain object to send to the client.
This method is usually called by the parent object.

Returns:

The client transfer object.

Type

object

Events

postCreate

The event arises after the business object instance has been initialized in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
newObject	EditableChildModelSync	The instance of the model after the data portal action.

postFetch

The event arises after the business object instance has been retrieved from the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
newObject	EditableChildModelSync	The instance of the model after the data portal action.

postInsert

The event arises after the business object instance has been created in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
newObject	EditableChildModelSync	The instance of the model after the data portal action.

postRemove

The event arises after the business object instance has been removed from the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
newObject	EditableChildModelSync	The instance of the model after the data portal action.

postUpdate

The event arises after the business object instance has been updated in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
newObject	EditableChildModelSync	The instance of the model after the data portal action.

preCreate

The event arises before the business object instance will be initialized in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
oldObject	EditableChildModelSync	The instance of the model before the data portal action.

preFetch

The event arises before the business object instance will be retrieved from the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
oldObject	EditableChildModelSync	The instance of the model before the data portal action.

preInsert

The event arises before the business object instance will be created in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
oldObject	EditableChildModelSync	The instance of the model before the data portal action.

preRemove

The event arises before the business object instance will be removed from the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
oldObject	EditableChildModelSync	The instance of the model before the data portal action.

preUpdate

The event arises before the business object instance will be updated in the repository.

Parameters:

Name	Type	Description
eventArgs	bo.shared.DataPortalEventArgs	Data portal event arguments.
oldObject	EditableChildModelSync	The instance of the model before the data portal action.