Class DifferenceItem<T>

Public

Type Parameters

Hierarchy (view full)

AbstractModel
- DifferenceItem

Implements

ITreeNodeModel<T, string>

Index

Constructors

constructor

Methods

afterInit beforeInit calculateDeepDirty calculateDirty calculateFieldsDirty calculateModelDirty checkFieldDirty clearValidationResult clone commit commitFields commitHasMany commitHasOne createFields createHasMany createHasOne getCollection getDeepDirty getDirty getErrorMessage getField getFieldJsonDescriptor getFieldMainDescriptor getFieldMainDescriptors getFields getFieldsMap getHasManyCollection getHasManyJsonDescriptor getHasManyMainDescriptor getHasManyMainDescriptors getHasManyMap getHasOneCollection getHasOneJsonDescriptor getHasOneMainDescriptor getHasOneMainDescriptors getHasOneMap getHasOneOriginalCollection getKey getLogicErrors getModelDirty getPhantom getPrimaryKeyValue getPropertiesAsMapByDescriptors getPropertiesByDescriptors getPropertyByDescriptor getReferencesChanged getValidationResult isEqual revert serialize setDeepDirty setDirty setPhantomCascade setReactive setReactiveCascade setReferencesChanged updateDeepDirty updateDirty updateModelDirty validate buildKey parseKey

Constructors

constructor

new DifferenceItem<T>(data, _descriptorConfig?, options?): DifferenceItem<T>
Type Parameters
- T
Parameters
- data: Partial<Pick<GetTypes<any>, string>>
- Optional_descriptorConfig: IStringKeyMap<any>
- Optionaloptions: Partial<ModelOptions>
Returns DifferenceItem<T>
Inherited from AbstractModel.constructor
- Defined in app-sdk/index.d.ts:411

Properties

changeType

changeType: EnumField<RevisionDifferenceTypeEnum, void>

children

children: ModelCollection<DifferenceItem<T>>

childrenCount

childrenCount: IntegerField<void>

dirty

dirty: boolean

displayName

displayName: StringField<void>

hasChildrenChange

hasChildrenChange: BooleanField<null>

indexChange

indexChange: NumberField<void>

leaf

leaf: BooleanField<void>

modelId

modelId: number

name

name: StringField<void>

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

onChangeDirty

onChangeDirty: (() => void)

onValidation

onValidation: ((_validationResult: IValidationResult) => void)

parentChange

parentChange: StringField<null>

parentChangeType

parentChangeType: EnumField<MoveNodeTypeEnum, null>

parentName

parentName: NodeKeyField<string>

parentPath

parentPath: ArrayField<string, void>

phantom

phantom: boolean

type

type: EnumField<T, void>

`Protected`validationResult

validationResult: IValidationResult

`Static`KEY_DELIMITER

KEY_DELIMITER: string

Methods

`Protected`afterInit

afterInit(): void
This method is called at the final stage of model initialization

Returns void
Implementation of ITreeNodeModel.afterInit
Inherited from AbstractModel.afterInit
- Defined in app-sdk/index.d.ts:419

`Protected`beforeInit

beforeInit(): void
The method calls before the model initialization begins

Returns void
Implementation of ITreeNodeModel.beforeInit
Inherited from AbstractModel.beforeInit
- Defined in app-sdk/index.d.ts:415

calculateDeepDirty

calculateDeepDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.calculateDeepDirty
Inherited from AbstractModel.calculateDeepDirty
- Defined in app-sdk/index.d.ts:606

calculateDirty

calculateDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.calculateDirty
Inherited from AbstractModel.calculateDirty
- Defined in app-sdk/index.d.ts:604

calculateFieldsDirty

calculateFieldsDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.calculateFieldsDirty
Inherited from AbstractModel.calculateFieldsDirty
- Defined in app-sdk/index.d.ts:571

calculateModelDirty

calculateModelDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.calculateModelDirty
Inherited from AbstractModel.calculateModelDirty
- Defined in app-sdk/index.d.ts:605

checkFieldDirty

checkFieldDirty(field): boolean
Parameters
- field: AbstractField<any, BaseOptions>
Returns boolean
Implementation of ITreeNodeModel.checkFieldDirty
Inherited from AbstractModel.checkFieldDirty
- Defined in app-sdk/index.d.ts:570

clearValidationResult

clearValidationResult(): void
Returns void
Implementation of ITreeNodeModel.clearValidationResult
Inherited from AbstractModel.clearValidationResult
- Defined in app-sdk/index.d.ts:589

clone

clone<T>(includeSystemProps?): T
Cloning model data
Type Parameters
- T extends AbstractModel<any>
Parameters
- OptionalincludeSystemProps: boolean
  phantom, dirty, original values
Returns T
T
Implementation of ITreeNodeModel.clone
Inherited from AbstractModel.clone
- Defined in app-sdk/index.d.ts:613

commit

commit(): void
Returns void
Implementation of ITreeNodeModel.commit
Inherited from AbstractModel.commit
- Defined in app-sdk/index.d.ts:539

`Protected`commitFields

commitFields(): void
Returns void
Implementation of ITreeNodeModel.commitFields
Inherited from AbstractModel.commitFields
- Defined in app-sdk/index.d.ts:541

`Protected`commitHasMany

commitHasMany(): void
Returns void
Implementation of ITreeNodeModel.commitHasMany
Inherited from AbstractModel.commitHasMany
- Defined in app-sdk/index.d.ts:543

`Protected`commitHasOne

commitHasOne(): void
Returns void
Implementation of ITreeNodeModel.commitHasOne
Inherited from AbstractModel.commitHasOne
- Defined in app-sdk/index.d.ts:542

`Protected`createFields

createFields(data): void
Creates model fields
Parameters
- data: any
Returns void
Implementation of ITreeNodeModel.createFields
Inherited from AbstractModel.createFields
- Defined in app-sdk/index.d.ts:431

`Protected`createHasMany

createHasMany(data, initConfig): void
Creates hasMany models
Parameters
- data: any
- initConfig: Partial<ModelOptions>
Returns void
Implementation of ITreeNodeModel.createHasMany
Inherited from AbstractModel.createHasMany
- Defined in app-sdk/index.d.ts:443

`Protected`createHasOne

createHasOne(data, initConfig): void
Creates hasOne models
Parameters
- data: any
- initConfig: Partial<ModelOptions>
Returns void
Implementation of ITreeNodeModel.createHasOne
Inherited from AbstractModel.createHasOne
- Defined in app-sdk/index.d.ts:439

getCollection

getCollection(name): any
Parameters
- name: string
Returns any
Implementation of ITreeNodeModel.getCollection
Inherited from AbstractModel.getCollection
- Defined in app-sdk/index.d.ts:458

getDeepDirty

getDeepDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.getDeepDirty
Inherited from AbstractModel.getDeepDirty
- Defined in app-sdk/index.d.ts:601

getDirty

getDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.getDirty
Inherited from AbstractModel.getDirty
- Defined in app-sdk/index.d.ts:583

getErrorMessage

getErrorMessage(validatorName): string
Parameters
- validatorName: string
Returns string
Implementation of ITreeNodeModel.getErrorMessage
Inherited from AbstractModel.getErrorMessage
- Defined in app-sdk/index.d.ts:614

getField

getField(name): undefined | AbstractField<any, BaseOptions>
Parameters
- name: string
Returns undefined | AbstractField<any, BaseOptions>
Implementation of ITreeNodeModel.getField
Inherited from AbstractModel.getField
- Defined in app-sdk/index.d.ts:457

getFieldJsonDescriptor

getFieldJsonDescriptor(propertyName): undefined | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
Returns a json descriptor for the model field by its name. The Json handle may not exist
Parameters
- propertyName: string
Returns undefined | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
Implementation of ITreeNodeModel.getFieldJsonDescriptor
Inherited from AbstractModel.getFieldJsonDescriptor
- Defined in app-sdk/index.d.ts:486

getFieldMainDescriptor

getFieldMainDescriptor(propertyName): ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
returns the main descriptor for the model field by its name. The main descriptor must exist
Parameters
- propertyName: string
Returns ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
Implementation of ITreeNodeModel.getFieldMainDescriptor
Inherited from AbstractModel.getFieldMainDescriptor
- Defined in app-sdk/index.d.ts:481

getFieldMainDescriptors

getFieldMainDescriptors(): ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>[]
Returns an array of the main descriptors of the model fields. Can include descriptors for which entities have not been created. The main descriptor must exist

Returns ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>[]
Implementation of ITreeNodeModel.getFieldMainDescriptors
Inherited from AbstractModel.getFieldMainDescriptors
- Defined in app-sdk/index.d.ts:476

getFields

getFields(): any[]
Returns an array of model fields

Returns any[]
Implementation of ITreeNodeModel.getFields
Inherited from AbstractModel.getFields
- Defined in app-sdk/index.d.ts:462

getFieldsMap

getFieldsMap(): {}
Returns {}
Implementation of ITreeNodeModel.getFieldsMap
Inherited from AbstractModel.getFieldsMap
- Defined in app-sdk/index.d.ts:463

getHasManyCollection

getHasManyCollection(): any[]
Returns the hasMany array of the model

Returns any[]
Implementation of ITreeNodeModel.getHasManyCollection
Inherited from AbstractModel.getHasManyCollection
- Defined in app-sdk/index.d.ts:515

getHasManyJsonDescriptor

getHasManyJsonDescriptor(propertyName): undefined | ClassPropertyDescriptor<any, ModelCollection<any>>
Returns the JSON descriptor of the hasMany model. The Json descriptor may NOT exist
Parameters
- propertyName: string
Returns undefined | ClassPropertyDescriptor<any, ModelCollection<any>>
Implementation of ITreeNodeModel.getHasManyJsonDescriptor
Inherited from AbstractModel.getHasManyJsonDescriptor
- Defined in app-sdk/index.d.ts:530

getHasManyMainDescriptor

getHasManyMainDescriptor(propertyName): ClassPropertyDescriptor<any, ModelCollection<any>>
Returns the main descriptor of the hasMany model. The main descriptor must exist
Parameters
- propertyName: string
Returns ClassPropertyDescriptor<any, ModelCollection<any>>
Implementation of ITreeNodeModel.getHasManyMainDescriptor
Inherited from AbstractModel.getHasManyMainDescriptor
- Defined in app-sdk/index.d.ts:525

getHasManyMainDescriptors

getHasManyMainDescriptors(): ClassPropertyDescriptor<any, ModelCollection<any>>[]
Returns an array of hasMany model descriptors. Can include descriptors for which entities have not been created. The main descriptor must exist

Returns ClassPropertyDescriptor<any, ModelCollection<any>>[]
Implementation of ITreeNodeModel.getHasManyMainDescriptors
Inherited from AbstractModel.getHasManyMainDescriptors
- Defined in app-sdk/index.d.ts:520

getHasManyMap

getHasManyMap(): {}
Returns {}
Implementation of ITreeNodeModel.getHasManyMap
Inherited from AbstractModel.getHasManyMap
- Defined in app-sdk/index.d.ts:466

getHasOneCollection

getHasOneCollection(): any[]
Returns the model's hasOne array

Returns any[]
Implementation of ITreeNodeModel.getHasOneCollection
Inherited from AbstractModel.getHasOneCollection
- Defined in app-sdk/index.d.ts:490

getHasOneJsonDescriptor

getHasOneJsonDescriptor(propertyName): undefined | ClassPropertyDescriptor<any, AbstractModel<any>>
Returns the model's has One json descriptor. Json handle may not exist
Parameters
- propertyName: string
Returns undefined | ClassPropertyDescriptor<any, AbstractModel<any>>
Implementation of ITreeNodeModel.getHasOneJsonDescriptor
Inherited from AbstractModel.getHasOneJsonDescriptor
- Defined in app-sdk/index.d.ts:505

getHasOneMainDescriptor

getHasOneMainDescriptor(propertyName): ClassPropertyDescriptor<any, AbstractModel<any>>
Returns the main hasone descriptor of the model. The main descriptor must exist
Parameters
- propertyName: string
Returns ClassPropertyDescriptor<any, AbstractModel<any>>
Implementation of ITreeNodeModel.getHasOneMainDescriptor
Inherited from AbstractModel.getHasOneMainDescriptor
- Defined in app-sdk/index.d.ts:500

getHasOneMainDescriptors

getHasOneMainDescriptors(): ClassPropertyDescriptor<any, AbstractModel<any>>[]
Returns an array of hasone model descriptors. Can include descriptors for which entities have not been created. The main descriptor must exist

Returns ClassPropertyDescriptor<any, AbstractModel<any>>[]
Implementation of ITreeNodeModel.getHasOneMainDescriptors
Inherited from AbstractModel.getHasOneMainDescriptors
- Defined in app-sdk/index.d.ts:495

getHasOneMap

getHasOneMap(): {}
Returns {}
Implementation of ITreeNodeModel.getHasOneMap
Inherited from AbstractModel.getHasOneMap
- Defined in app-sdk/index.d.ts:469

getHasOneOriginalCollection

getHasOneOriginalCollection(): {}
Returns an array of original hasOne

Returns {}
Implementation of ITreeNodeModel.getHasOneOriginalCollection
Inherited from AbstractModel.getHasOneOriginalCollection
- Defined in app-sdk/index.d.ts:509

getKey

getKey(): string
Returns string
Implementation of ITreeNodeModel.getKey
- Defined in app-sdk/index.d.ts:3485

getLogicErrors

getLogicErrors(): string[]
This method is called at the validation. If there is logical errors in model, here will be list of them

Returns string[]
Implementation of ITreeNodeModel.getLogicErrors
Inherited from AbstractModel.getLogicErrors
- Defined in app-sdk/index.d.ts:423

getModelDirty

getModelDirty(): boolean
Returns boolean
Implementation of ITreeNodeModel.getModelDirty
Inherited from AbstractModel.getModelDirty
- Defined in app-sdk/index.d.ts:602

getPhantom

getPhantom(): boolean
Returns whether a new record is selected

Returns boolean
Implementation of ITreeNodeModel.getPhantom
Inherited from AbstractModel.getPhantom
- Defined in app-sdk/index.d.ts:587

getPrimaryKeyValue

getPrimaryKeyValue(): string
Returns the primary key value

Returns string
Implementation of ITreeNodeModel.getPrimaryKeyValue
Inherited from AbstractModel.getPrimaryKeyValue
- Defined in app-sdk/index.d.ts:534

`Protected`getPropertiesAsMapByDescriptors

getPropertiesAsMapByDescriptors<T>(descriptors): {
[key in string]?: ModelProperty<any, T, any>
}
Returns a map of model properties based on the passed descriptors. The key is the property name, and the value is the property itself.
Type Parameters
- T extends AbstractModel<any> | AbstractField<any, BaseOptions> | ModelCollection<any>
Parameters
- descriptors: ClassPropertyDescriptor<any, T>[]
Returns {
[key in string]?: ModelProperty<any, T, any>
}
Implementation of ITreeNodeModel.getPropertiesAsMapByDescriptors
Inherited from AbstractModel.getPropertiesAsMapByDescriptors
- Defined in app-sdk/index.d.ts:456

`Protected`getPropertiesByDescriptors

getPropertiesByDescriptors<T>(descriptors): ModelProperty<any, T, any>[]
Returns an array of model properties based on the passed descriptors Only certain values are returned.
Type Parameters
- T extends AbstractModel<any> | AbstractField<any, BaseOptions> | ModelCollection<any>
Parameters
- descriptors: ClassPropertyDescriptor<any, T>[]
Returns ModelProperty<any, T, any>[]
Implementation of ITreeNodeModel.getPropertiesByDescriptors
Inherited from AbstractModel.getPropertiesByDescriptors
- Defined in app-sdk/index.d.ts:452

`Protected`getPropertyByDescriptor

getPropertyByDescriptor<T>(descriptor): undefined | ModelProperty<any, T, any>
Returns the model property (field, has One, has Many) by the main handle
Type Parameters
- T extends AbstractModel<any> | AbstractField<any, BaseOptions> | ModelCollection<any>
Parameters
- descriptor: ClassPropertyDescriptor<any, T>
Returns undefined | ModelProperty<any, T, any>
Implementation of ITreeNodeModel.getPropertyByDescriptor
Inherited from AbstractModel.getPropertyByDescriptor
- Defined in app-sdk/index.d.ts:447

getReferencesChanged

getReferencesChanged(): boolean
Returns boolean
Implementation of ITreeNodeModel.getReferencesChanged
Inherited from AbstractModel.getReferencesChanged
- Defined in app-sdk/index.d.ts:599

getValidationResult

getValidationResult(level?): Map<string, string[]>
Parameters
- Optionallevel: number
Returns Map<string, string[]>
Implementation of ITreeNodeModel.getValidationResult
Inherited from AbstractModel.getValidationResult
- Defined in app-sdk/index.d.ts:588

isEqual

isEqual(model, config?): boolean
Parameters
- model: AbstractModel<any>
- Optionalconfig: EqualConfig
Returns boolean
Implementation of ITreeNodeModel.isEqual
Inherited from AbstractModel.isEqual
- Defined in app-sdk/index.d.ts:572

revert

revert(): void
Returns void
Implementation of ITreeNodeModel.revert
Inherited from AbstractModel.revert
- Defined in app-sdk/index.d.ts:540

serialize

serialize(config?): Partial<Pick<GetTypes<any>, string>>
Returns a serialized view of the model
Parameters
- Optionalconfig: SerializationConfig
Returns Partial<Pick<GetTypes<any>, string>>
Implementation of ITreeNodeModel.serialize
Inherited from AbstractModel.serialize
- Defined in app-sdk/index.d.ts:538

setDeepDirty

setDeepDirty(flag): void
Parameters
- flag: boolean
Returns void
Implementation of ITreeNodeModel.setDeepDirty
Inherited from AbstractModel.setDeepDirty
- Defined in app-sdk/index.d.ts:603

setDirty

setDirty(flag): void
Parameters
- flag: boolean
Returns void
Implementation of ITreeNodeModel.setDirty
Inherited from AbstractModel.setDirty
- Defined in app-sdk/index.d.ts:598

setPhantomCascade

setPhantomCascade(phantom): void
Sets the phantom attribute cascadingly for the model
Parameters
- phantom: boolean
Returns void
Implementation of ITreeNodeModel.setPhantomCascade
Inherited from AbstractModel.setPhantomCascade
- Defined in app-sdk/index.d.ts:597

setReactive

setReactive(props): void
Make some of the system properties reactive in the current model
Parameters
- props: ReactiveProp[]
  list of system properties
Returns void
Implementation of ITreeNodeModel.setReactive
Inherited from AbstractModel.setReactive
- Defined in app-sdk/index.d.ts:1744

setReactiveCascade

setReactiveCascade(props): void
Make some of the system properties reactive cascading throughout the model
Parameters
- props: ReactiveProp[]
  list of system properties
Returns void
Implementation of ITreeNodeModel.setReactiveCascade
Inherited from AbstractModel.setReactiveCascade
- Defined in app-sdk/index.d.ts:564

setReferencesChanged

setReferencesChanged(flag): void
Parameters
- flag: boolean
Returns void
Implementation of ITreeNodeModel.setReferencesChanged
Inherited from AbstractModel.setReferencesChanged
- Defined in app-sdk/index.d.ts:600

updateDeepDirty

updateDeepDirty(): void
Returns void
Implementation of ITreeNodeModel.updateDeepDirty
Inherited from AbstractModel.updateDeepDirty
- Defined in app-sdk/index.d.ts:581

updateDirty

updateDirty(): void
Returns void
Implementation of ITreeNodeModel.updateDirty
Inherited from AbstractModel.updateDirty
- Defined in app-sdk/index.d.ts:582

updateModelDirty

updateModelDirty(): void
Returns void
Implementation of ITreeNodeModel.updateModelDirty
Inherited from AbstractModel.updateModelDirty
- Defined in app-sdk/index.d.ts:579

validate

validate(disablePropagation?): IValidationResult
Parameters
- OptionaldisablePropagation: boolean
  Parent cmp notification flag about validation
Returns IValidationResult
Implementation of ITreeNodeModel.validate
Inherited from AbstractModel.validate
- Defined in app-sdk/index.d.ts:569

`Static`buildKey

buildKey<TREE_NODE>(node): string
Type Parameters
- TREE_NODE
Parameters
- node: DifferenceItem<TREE_NODE>
Returns string
- Defined in app-sdk/index.d.ts:3486

`Static`parseKey

parseKey(key): string[]
Parameters
- key: string
Returns string[]
- Defined in app-sdk/index.d.ts:3487

Class DifferenceItem<T>

Public

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DifferenceItem<T>

Properties

changeType

children

childrenCount

dirty

displayName

hasChildrenChange

indexChange

leaf

modelId

name

ProtectedobservabilitySet

onChangeDirty

onValidation

parentChange

parentChangeType

parentName

parentPath

phantom

type

ProtectedvalidationResult

StaticKEY_DELIMITER

Methods

ProtectedafterInit

Returns void

ProtectedbeforeInit

Returns void

calculateDeepDirty

Returns boolean

calculateDirty

Returns boolean

calculateFieldsDirty

Returns boolean

calculateModelDirty

Returns boolean

checkFieldDirty

Parameters

Returns boolean

clearValidationResult

Returns void

clone

Type Parameters

Parameters

Returns T

commit

Returns void

ProtectedcommitFields

Returns void

ProtectedcommitHasMany

Returns void

ProtectedcommitHasOne

Returns void

ProtectedcreateFields

Parameters

Returns void

ProtectedcreateHasMany

Parameters

Returns void

ProtectedcreateHasOne

Parameters

Returns void

getCollection

Parameters

Returns any

getDeepDirty

Returns boolean

`Protected`observabilitySet

`Protected`validationResult

`Static`KEY_DELIMITER

`Protected`afterInit

`Protected`beforeInit

`Protected`commitFields

`Protected`commitHasMany

`Protected`commitHasOne

`Protected`createFields

`Protected`createHasMany

`Protected`createHasOne

`Protected`getPropertiesAsMapByDescriptors

Returns {
[key in string]?: ModelProperty<any, T, any>
}

`Protected`getPropertiesByDescriptors

`Protected`getPropertyByDescriptor