Class UserProperty

Public

Hierarchy (view full)

Property
- UserProperty

Index

Constructors

Properties

dirty displayName id modelId name observabilitySet onChangeDirty onValidation phantom readOnly required validationResult value

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 getLogicErrors getModelDirty getPhantom getPrimaryKeyValue getPropertiesAsMapByDescriptors getPropertiesByDescriptors getPropertyByDescriptor getReferencesChanged getValidationResult isEqual revert serialize setDeepDirty setDirty setPhantomCascade setReactive setReactiveCascade setReferencesChanged updateDeepDirty updateDirty updateModelDirty validate

Constructors

constructor

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

Properties

dirty

dirty: boolean

displayName

displayName: StringField<void>

id

id: NumberField<void>

modelId

modelId: number

name

name: StringField<void>

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

onChangeDirty

onChangeDirty: (() => void)

onValidation

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

phantom

phantom: boolean

readOnly

readOnly: BooleanField<void>

required

required: BooleanField<void>

`Protected`validationResult

validationResult: IValidationResult

value

value: StringField<void>

Methods

`Protected`afterInit

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

Returns void
Inherited from Property.afterInit
- Defined in app-sdk/index.d.ts:419

`Protected`beforeInit

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

Returns void
Inherited from Property.beforeInit
- Defined in app-sdk/index.d.ts:415

calculateDeepDirty

calculateDeepDirty(): boolean
Returns boolean
Inherited from Property.calculateDeepDirty
- Defined in app-sdk/index.d.ts:606

calculateDirty

calculateDirty(): boolean
Returns boolean
Inherited from Property.calculateDirty
- Defined in app-sdk/index.d.ts:604

calculateFieldsDirty

calculateFieldsDirty(): boolean
Returns boolean
Inherited from Property.calculateFieldsDirty
- Defined in app-sdk/index.d.ts:571

calculateModelDirty

calculateModelDirty(): boolean
Returns boolean
Inherited from Property.calculateModelDirty
- Defined in app-sdk/index.d.ts:605

checkFieldDirty

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

clearValidationResult

clearValidationResult(): void
Returns void
Inherited from Property.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
Inherited from Property.clone
- Defined in app-sdk/index.d.ts:613

commit

commit(): void
Returns void
Inherited from Property.commit
- Defined in app-sdk/index.d.ts:539

`Protected`commitFields

commitFields(): void
Returns void
Inherited from Property.commitFields
- Defined in app-sdk/index.d.ts:541

`Protected`commitHasMany

commitHasMany(): void
Returns void
Inherited from Property.commitHasMany
- Defined in app-sdk/index.d.ts:543

`Protected`commitHasOne

commitHasOne(): void
Returns void
Inherited from Property.commitHasOne
- Defined in app-sdk/index.d.ts:542

`Protected`createFields

createFields(data): void
Creates model fields
Parameters
- data: any
Returns void
Inherited from Property.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
Inherited from Property.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
Inherited from Property.createHasOne
- Defined in app-sdk/index.d.ts:439

getCollection

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

getDeepDirty

getDeepDirty(): boolean
Returns boolean
Inherited from Property.getDeepDirty
- Defined in app-sdk/index.d.ts:601

getDirty

getDirty(): boolean
Returns boolean
Inherited from Property.getDirty
- Defined in app-sdk/index.d.ts:583

getErrorMessage

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

getField

getField(name): undefined | AbstractField<any, BaseOptions>
Parameters
- name: string
Returns undefined | AbstractField<any, BaseOptions>
Inherited from Property.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>>
Inherited from Property.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>>
Inherited from Property.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>>[]
Inherited from Property.getFieldMainDescriptors
- Defined in app-sdk/index.d.ts:476

getFields

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

Returns any[]
Inherited from Property.getFields
- Defined in app-sdk/index.d.ts:462

getFieldsMap

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

getHasManyCollection

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

Returns any[]
Inherited from Property.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>>
Inherited from Property.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>>
Inherited from Property.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>>[]
Inherited from Property.getHasManyMainDescriptors
- Defined in app-sdk/index.d.ts:520

getHasManyMap

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

getHasOneCollection

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

Returns any[]
Inherited from Property.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>>
Inherited from Property.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>>
Inherited from Property.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>>[]
Inherited from Property.getHasOneMainDescriptors
- Defined in app-sdk/index.d.ts:495

getHasOneMap

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

getHasOneOriginalCollection

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

Returns {}
Inherited from Property.getHasOneOriginalCollection
- Defined in app-sdk/index.d.ts:509

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[]
Inherited from Property.getLogicErrors
- Defined in app-sdk/index.d.ts:423

getModelDirty

getModelDirty(): boolean
Returns boolean
Inherited from Property.getModelDirty
- Defined in app-sdk/index.d.ts:602

getPhantom

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

Returns boolean
Inherited from Property.getPhantom
- Defined in app-sdk/index.d.ts:587

getPrimaryKeyValue

getPrimaryKeyValue(): string
Returns the primary key value

Returns string
Inherited from Property.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>
}
Inherited from Property.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>[]
Inherited from Property.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>
Inherited from Property.getPropertyByDescriptor
- Defined in app-sdk/index.d.ts:447

getReferencesChanged

getReferencesChanged(): boolean
Returns boolean
Inherited from Property.getReferencesChanged
- Defined in app-sdk/index.d.ts:599

getValidationResult

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

isEqual

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

revert

revert(): void
Returns void
Inherited from Property.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>>
Inherited from Property.serialize
- Defined in app-sdk/index.d.ts:538

setDeepDirty

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

setDirty

setDirty(flag): void
Parameters
- flag: boolean
Returns void
Inherited from Property.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
Inherited from Property.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
Inherited from Property.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
Inherited from Property.setReactiveCascade
- Defined in app-sdk/index.d.ts:564

setReferencesChanged

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

updateDeepDirty

updateDeepDirty(): void
Returns void
Inherited from Property.updateDeepDirty
- Defined in app-sdk/index.d.ts:581

updateDirty

updateDirty(): void
Returns void
Inherited from Property.updateDirty
- Defined in app-sdk/index.d.ts:582

updateModelDirty

updateModelDirty(): void
Returns void
Inherited from Property.updateModelDirty
- Defined in app-sdk/index.d.ts:579

validate

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

Class UserProperty

Public

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserProperty

Properties

dirty

displayName

id

modelId

name

ProtectedobservabilitySet

onChangeDirty

onValidation

phantom

readOnly

required

ProtectedvalidationResult

value

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

getDirty

Returns boolean

getErrorMessage

Parameters

Returns string

getField

Parameters

Returns undefined | AbstractField<any, BaseOptions>

getFieldJsonDescriptor

Parameters

Returns undefined | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>

`Protected`observabilitySet

`Protected`validationResult

`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