Class ComplexAttribute

Public

Hierarchy (view full)

AbstractAttribute<ComplexAttribute>
- ComplexAttribute

Implements

IMetaComplexAttribute

Index

Constructors

constructor

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

Properties

customProperties

customProperties: ModelCollection<CustomProperty>

defaultValue

defaultValue: StringField<null>

description

description: StringField<void>

dirty

dirty: boolean

displayName

displayName: StringField<void>

hidden

hidden: BooleanField<void>

maxCount

maxCount: IntegerField<null>

minCount

minCount: IntegerField<void>

modelId

modelId: number

name

name: StringField<void>

nestedEntity

nestedEntity: null | NestedEntity

nestedEntityKeyAttribute

nestedEntityKeyAttribute: StringField<null>

nestedEntityName

nestedEntityName: StringField<void>

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

onChangeDirty

onChangeDirty: (() => void)

onValidation

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

order

order: IntegerField<void>

phantom

phantom: boolean

readOnly

readOnly: BooleanField<void>

rights

rights: null | Right

`Protected`validationResult

validationResult: IValidationResult

`Static`defaultInitData

defaultInitData: IKeyValueMap<string>

Accessors

isCreatable

get isCreatable(): boolean
Returns boolean
Inherited from AbstractAttribute.isCreatable
- Defined in app-sdk/index.d.ts:48

isEditable

get isEditable(): boolean
Returns boolean
Inherited from AbstractAttribute.isEditable
- Defined in app-sdk/index.d.ts:47

isIndexable

get isIndexable(): boolean
Returns boolean
Implementation of IMetaComplexAttribute.isIndexable
Inherited from AbstractAttribute.isIndexable
- Defined in app-sdk/index.d.ts:45

isReadable

get isReadable(): boolean
Returns boolean
Implementation of IMetaComplexAttribute.isReadable
Inherited from AbstractAttribute.isReadable
- Defined in app-sdk/index.d.ts:46

processedDefaultValue

get processedDefaultValue(): any
Returns any
Implementation of IMetaComplexAttribute.processedDefaultValue
Inherited from AbstractAttribute.processedDefaultValue
- Defined in app-sdk/index.d.ts:44

typeCategory

get typeCategory(): null | AttributeTypeCategory
Returns null | AttributeTypeCategory
Implementation of IMetaComplexAttribute.typeCategory
Inherited from AbstractAttribute.typeCategory
- Defined in app-sdk/index.d.ts:24

typeValue

get typeValue():
    | undefined
    | ARRAY_DATA_TYPE
    | CODE_DATA_TYPE
    | SIMPLE_DATA_TYPE
Returns
    | undefined
    | ARRAY_DATA_TYPE
    | CODE_DATA_TYPE
    | SIMPLE_DATA_TYPE
Implementation of IMetaComplexAttribute.typeValue
Inherited from AbstractAttribute.typeValue
- Defined in app-sdk/index.d.ts:25

Methods

`Protected`afterInit

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

Returns void
Implementation of IMetaComplexAttribute.afterInit
Inherited from AbstractAttribute.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 IMetaComplexAttribute.beforeInit
Inherited from AbstractAttribute.beforeInit
- Defined in app-sdk/index.d.ts:415

calculateDeepDirty

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

calculateDirty

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

calculateFieldsDirty

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

calculateModelDirty

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

checkFieldDirty

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

clearTypeValues

clearTypeValues(typeCategories?): void
Clearing type values according to a list
Parameters
- OptionaltypeCategories: AttributeTypeCategory[]
Returns void
Inherited from AbstractAttribute.clearTypeValues
- Defined in app-sdk/index.d.ts:29

clearValidationResult

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

commit

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

`Protected`commitFields

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

`Protected`commitHasMany

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

`Protected`commitHasOne

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

`Protected`createFields

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

getAvailableTypeCategories

getAvailableTypeCategories(): AttributeTypeCategory[]
Returns an array of available type categories for a particular kind of attribute

Returns AttributeTypeCategory[]
Overrides AbstractAttribute.getAvailableTypeCategories
- Defined in app-sdk/index.d.ts:2967

getCollection

getCollection(name): any
Parameters
- name: ModelFieldCollectionKey<ComplexAttribute, any>
Returns any
Implementation of IMetaComplexAttribute.getCollection
Inherited from AbstractAttribute.getCollection
- Defined in app-sdk/index.d.ts:458

getCustomProperty

getCustomProperty(key): null | CustomProperty
Parameters
- key: string
Returns null | CustomProperty
Implementation of IMetaComplexAttribute.getCustomProperty
Inherited from AbstractAttribute.getCustomProperty
- Defined in app-sdk/index.d.ts:36

getCustomPropertyJsonValue

getCustomPropertyJsonValue<T>(key): undefined | T
Type Parameters
- T
Parameters
- key: string
Returns undefined | T
Implementation of IMetaComplexAttribute.getCustomPropertyJsonValue
Inherited from AbstractAttribute.getCustomPropertyJsonValue
- Defined in app-sdk/index.d.ts:37

getDeepDirty

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

getDirty

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

getErrorMessage

getErrorMessage(validatorName): string
Parameters
- validatorName: string
Returns string
Implementation of IMetaComplexAttribute.getErrorMessage
Inherited from AbstractAttribute.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 IMetaComplexAttribute.getField
Inherited from AbstractAttribute.getField
- Defined in app-sdk/index.d.ts:457

getFieldJsonDescriptor

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

getFieldMainDescriptor

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

getFieldMainDescriptors

getFieldMainDescriptors(): ClassPropertyDescriptor<ComplexAttribute, 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<ComplexAttribute, AbstractField<any, BaseOptions>>[]
Implementation of IMetaComplexAttribute.getFieldMainDescriptors
Inherited from AbstractAttribute.getFieldMainDescriptors
- Defined in app-sdk/index.d.ts:476

getFields

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

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

getFieldsMap

getFieldsMap(): {
    defaultValue: any;
    description: any;
    displayName: any;
    hidden: any;
    maxCount: any;
    minCount: any;
    name: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    order: any;
    processedDefaultValue: any;
    readOnly: any;
}
Returns {
    defaultValue: any;
    description: any;
    displayName: any;
    hidden: any;
    maxCount: any;
    minCount: any;
    name: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    order: any;
    processedDefaultValue: any;
    readOnly: any;
}
- defaultValue: any
- description: any
- displayName: any
- hidden: any
- maxCount: any
- minCount: any
- name: any
- nestedEntityKeyAttribute: any
- nestedEntityName: any
- order: any
- processedDefaultValue: any
- readOnly: any
Implementation of IMetaComplexAttribute.getFieldsMap
Inherited from AbstractAttribute.getFieldsMap
- Defined in app-sdk/index.d.ts:463

getHasManyCollection

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

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

getHasManyJsonDescriptor

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

getHasManyMainDescriptor

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

getHasManyMainDescriptors

getHasManyMainDescriptors(): ClassPropertyDescriptor<ComplexAttribute, 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<ComplexAttribute, ModelCollection<any>>[]
Implementation of IMetaComplexAttribute.getHasManyMainDescriptors
Inherited from AbstractAttribute.getHasManyMainDescriptors
- Defined in app-sdk/index.d.ts:520

getHasManyMap

getHasManyMap(): {
customProperties: any;
processedDefaultValue: any;
}
Returns {
customProperties: any;
processedDefaultValue: any;
}
- customProperties: any
- processedDefaultValue: any
Implementation of IMetaComplexAttribute.getHasManyMap
Inherited from AbstractAttribute.getHasManyMap
- Defined in app-sdk/index.d.ts:466

getHasOneCollection

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

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

getHasOneJsonDescriptor

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

getHasOneMainDescriptor

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

getHasOneMainDescriptors

getHasOneMainDescriptors(): ClassPropertyDescriptor<ComplexAttribute, 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<ComplexAttribute, AbstractModel<any>>[]
Implementation of IMetaComplexAttribute.getHasOneMainDescriptors
Inherited from AbstractAttribute.getHasOneMainDescriptors
- Defined in app-sdk/index.d.ts:495

getHasOneMap

getHasOneMap(): {
    calculateDeepDirty: any;
    calculateDirty: any;
    calculateFieldsDirty: any;
    calculateModelDirty: any;
    checkFieldDirty: any;
    clearTypeValues: any;
    clearValidationResult: any;
    clone: any;
    commit: any;
    customProperties: any;
    defaultValue: any;
    description: any;
    dirty: any;
    displayName: any;
    getAvailableTypeCategories: any;
    getCollection: any;
    getCustomProperty: any;
    getCustomPropertyJsonValue: any;
    getDeepDirty: any;
    getDirty: any;
    getErrorMessage: any;
    getField: any;
    getFieldJsonDescriptor: any;
    getFieldMainDescriptor: any;
    getFieldMainDescriptors: any;
    getFields: any;
    getFieldsMap: any;
    getHasManyCollection: any;
    getHasManyJsonDescriptor: any;
    getHasManyMainDescriptor: any;
    getHasManyMainDescriptors: any;
    getHasManyMap: any;
    getHasOneCollection: any;
    getHasOneJsonDescriptor: any;
    getHasOneMainDescriptor: any;
    getHasOneMainDescriptors: any;
    getHasOneMap: any;
    getHasOneOriginalCollection: any;
    getLogicErrors: any;
    getModelDirty: any;
    getPhantom: any;
    getPrimaryKeyValue: any;
    getReferencesChanged: any;
    getValidationResult: any;
    hidden: any;
    isCreatable: any;
    isEditable: any;
    isEqual: any;
    isIndexable: any;
    isReadable: any;
    maxCount: any;
    minCount: any;
    modelId: any;
    name: any;
    nestedEntity: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    onChangeDirty: any;
    onValidation: any;
    order: any;
    phantom: any;
    processedDefaultValue: any;
    readOnly: any;
    revert: any;
    rights: any;
    serialize: any;
    setCustomPropertyValue: any;
    setDeepDirty: any;
    setDirty: any;
    setPhantomCascade: any;
    setReactive: any;
    setReactiveCascade: any;
    setReferencesChanged: any;
    setTypeValue: any;
    typeCategory: any;
    typeValue: any;
    updateDeepDirty: any;
    updateDirty: any;
    updateModelDirty: any;
    validate: any;
}
Returns {
    calculateDeepDirty: any;
    calculateDirty: any;
    calculateFieldsDirty: any;
    calculateModelDirty: any;
    checkFieldDirty: any;
    clearTypeValues: any;
    clearValidationResult: any;
    clone: any;
    commit: any;
    customProperties: any;
    defaultValue: any;
    description: any;
    dirty: any;
    displayName: any;
    getAvailableTypeCategories: any;
    getCollection: any;
    getCustomProperty: any;
    getCustomPropertyJsonValue: any;
    getDeepDirty: any;
    getDirty: any;
    getErrorMessage: any;
    getField: any;
    getFieldJsonDescriptor: any;
    getFieldMainDescriptor: any;
    getFieldMainDescriptors: any;
    getFields: any;
    getFieldsMap: any;
    getHasManyCollection: any;
    getHasManyJsonDescriptor: any;
    getHasManyMainDescriptor: any;
    getHasManyMainDescriptors: any;
    getHasManyMap: any;
    getHasOneCollection: any;
    getHasOneJsonDescriptor: any;
    getHasOneMainDescriptor: any;
    getHasOneMainDescriptors: any;
    getHasOneMap: any;
    getHasOneOriginalCollection: any;
    getLogicErrors: any;
    getModelDirty: any;
    getPhantom: any;
    getPrimaryKeyValue: any;
    getReferencesChanged: any;
    getValidationResult: any;
    hidden: any;
    isCreatable: any;
    isEditable: any;
    isEqual: any;
    isIndexable: any;
    isReadable: any;
    maxCount: any;
    minCount: any;
    modelId: any;
    name: any;
    nestedEntity: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    onChangeDirty: any;
    onValidation: any;
    order: any;
    phantom: any;
    processedDefaultValue: any;
    readOnly: any;
    revert: any;
    rights: any;
    serialize: any;
    setCustomPropertyValue: any;
    setDeepDirty: any;
    setDirty: any;
    setPhantomCascade: any;
    setReactive: any;
    setReactiveCascade: any;
    setReferencesChanged: any;
    setTypeValue: any;
    typeCategory: any;
    typeValue: any;
    updateDeepDirty: any;
    updateDirty: any;
    updateModelDirty: any;
    validate: any;
}
- calculateDeepDirty: any
- calculateDirty: any
- calculateFieldsDirty: any
- calculateModelDirty: any
- checkFieldDirty: any
- clearTypeValues: any
- clearValidationResult: any
- clone: any
- commit: any
- customProperties: any
- defaultValue: any
- description: any
- dirty: any
- displayName: any
- getAvailableTypeCategories: any
- getCollection: any
- getCustomProperty: any
- getCustomPropertyJsonValue: any
- getDeepDirty: any
- getDirty: any
- getErrorMessage: any
- getField: any
- getFieldJsonDescriptor: any
- getFieldMainDescriptor: any
- getFieldMainDescriptors: any
- getFields: any
- getFieldsMap: any
- getHasManyCollection: any
- getHasManyJsonDescriptor: any
- getHasManyMainDescriptor: any
- getHasManyMainDescriptors: any
- getHasManyMap: any
- getHasOneCollection: any
- getHasOneJsonDescriptor: any
- getHasOneMainDescriptor: any
- getHasOneMainDescriptors: any
- getHasOneMap: any
- getHasOneOriginalCollection: any
- getLogicErrors: any
- getModelDirty: any
- getPhantom: any
- getPrimaryKeyValue: any
- getReferencesChanged: any
- getValidationResult: any
- hidden: any
- isCreatable: any
- isEditable: any
- isEqual: any
- isIndexable: any
- isReadable: any
- maxCount: any
- minCount: any
- modelId: any
- name: any
- nestedEntity: any
- nestedEntityKeyAttribute: any
- nestedEntityName: any
- onChangeDirty: any
- onValidation: any
- order: any
- phantom: any
- processedDefaultValue: any
- readOnly: any
- revert: any
- rights: any
- serialize: any
- setCustomPropertyValue: any
- setDeepDirty: any
- setDirty: any
- setPhantomCascade: any
- setReactive: any
- setReactiveCascade: any
- setReferencesChanged: any
- setTypeValue: any
- typeCategory: any
- typeValue: any
- updateDeepDirty: any
- updateDirty: any
- updateModelDirty: any
- validate: any
Implementation of IMetaComplexAttribute.getHasOneMap
Inherited from AbstractAttribute.getHasOneMap
- Defined in app-sdk/index.d.ts:469

getHasOneOriginalCollection

getHasOneOriginalCollection(): {
    calculateDeepDirty: any;
    calculateDirty: any;
    calculateFieldsDirty: any;
    calculateModelDirty: any;
    checkFieldDirty: any;
    clearTypeValues: any;
    clearValidationResult: any;
    clone: any;
    commit: any;
    customProperties: any;
    defaultValue: any;
    description: any;
    dirty: any;
    displayName: any;
    getAvailableTypeCategories: any;
    getCollection: any;
    getCustomProperty: any;
    getCustomPropertyJsonValue: any;
    getDeepDirty: any;
    getDirty: any;
    getErrorMessage: any;
    getField: any;
    getFieldJsonDescriptor: any;
    getFieldMainDescriptor: any;
    getFieldMainDescriptors: any;
    getFields: any;
    getFieldsMap: any;
    getHasManyCollection: any;
    getHasManyJsonDescriptor: any;
    getHasManyMainDescriptor: any;
    getHasManyMainDescriptors: any;
    getHasManyMap: any;
    getHasOneCollection: any;
    getHasOneJsonDescriptor: any;
    getHasOneMainDescriptor: any;
    getHasOneMainDescriptors: any;
    getHasOneMap: any;
    getHasOneOriginalCollection: any;
    getLogicErrors: any;
    getModelDirty: any;
    getPhantom: any;
    getPrimaryKeyValue: any;
    getReferencesChanged: any;
    getValidationResult: any;
    hidden: any;
    isCreatable: any;
    isEditable: any;
    isEqual: any;
    isIndexable: any;
    isReadable: any;
    maxCount: any;
    minCount: any;
    modelId: any;
    name: any;
    nestedEntity: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    onChangeDirty: any;
    onValidation: any;
    order: any;
    phantom: any;
    processedDefaultValue: any;
    readOnly: any;
    revert: any;
    rights: any;
    serialize: any;
    setCustomPropertyValue: any;
    setDeepDirty: any;
    setDirty: any;
    setPhantomCascade: any;
    setReactive: any;
    setReactiveCascade: any;
    setReferencesChanged: any;
    setTypeValue: any;
    typeCategory: any;
    typeValue: any;
    updateDeepDirty: any;
    updateDirty: any;
    updateModelDirty: any;
    validate: any;
}
Returns an array of original hasOne

Returns {
    calculateDeepDirty: any;
    calculateDirty: any;
    calculateFieldsDirty: any;
    calculateModelDirty: any;
    checkFieldDirty: any;
    clearTypeValues: any;
    clearValidationResult: any;
    clone: any;
    commit: any;
    customProperties: any;
    defaultValue: any;
    description: any;
    dirty: any;
    displayName: any;
    getAvailableTypeCategories: any;
    getCollection: any;
    getCustomProperty: any;
    getCustomPropertyJsonValue: any;
    getDeepDirty: any;
    getDirty: any;
    getErrorMessage: any;
    getField: any;
    getFieldJsonDescriptor: any;
    getFieldMainDescriptor: any;
    getFieldMainDescriptors: any;
    getFields: any;
    getFieldsMap: any;
    getHasManyCollection: any;
    getHasManyJsonDescriptor: any;
    getHasManyMainDescriptor: any;
    getHasManyMainDescriptors: any;
    getHasManyMap: any;
    getHasOneCollection: any;
    getHasOneJsonDescriptor: any;
    getHasOneMainDescriptor: any;
    getHasOneMainDescriptors: any;
    getHasOneMap: any;
    getHasOneOriginalCollection: any;
    getLogicErrors: any;
    getModelDirty: any;
    getPhantom: any;
    getPrimaryKeyValue: any;
    getReferencesChanged: any;
    getValidationResult: any;
    hidden: any;
    isCreatable: any;
    isEditable: any;
    isEqual: any;
    isIndexable: any;
    isReadable: any;
    maxCount: any;
    minCount: any;
    modelId: any;
    name: any;
    nestedEntity: any;
    nestedEntityKeyAttribute: any;
    nestedEntityName: any;
    onChangeDirty: any;
    onValidation: any;
    order: any;
    phantom: any;
    processedDefaultValue: any;
    readOnly: any;
    revert: any;
    rights: any;
    serialize: any;
    setCustomPropertyValue: any;
    setDeepDirty: any;
    setDirty: any;
    setPhantomCascade: any;
    setReactive: any;
    setReactiveCascade: any;
    setReferencesChanged: any;
    setTypeValue: any;
    typeCategory: any;
    typeValue: any;
    updateDeepDirty: any;
    updateDirty: any;
    updateModelDirty: any;
    validate: any;
}
- calculateDeepDirty: any
- calculateDirty: any
- calculateFieldsDirty: any
- calculateModelDirty: any
- checkFieldDirty: any
- clearTypeValues: any
- clearValidationResult: any
- clone: any
- commit: any
- customProperties: any
- defaultValue: any
- description: any
- dirty: any
- displayName: any
- getAvailableTypeCategories: any
- getCollection: any
- getCustomProperty: any
- getCustomPropertyJsonValue: any
- getDeepDirty: any
- getDirty: any
- getErrorMessage: any
- getField: any
- getFieldJsonDescriptor: any
- getFieldMainDescriptor: any
- getFieldMainDescriptors: any
- getFields: any
- getFieldsMap: any
- getHasManyCollection: any
- getHasManyJsonDescriptor: any
- getHasManyMainDescriptor: any
- getHasManyMainDescriptors: any
- getHasManyMap: any
- getHasOneCollection: any
- getHasOneJsonDescriptor: any
- getHasOneMainDescriptor: any
- getHasOneMainDescriptors: any
- getHasOneMap: any
- getHasOneOriginalCollection: any
- getLogicErrors: any
- getModelDirty: any
- getPhantom: any
- getPrimaryKeyValue: any
- getReferencesChanged: any
- getValidationResult: any
- hidden: any
- isCreatable: any
- isEditable: any
- isEqual: any
- isIndexable: any
- isReadable: any
- maxCount: any
- minCount: any
- modelId: any
- name: any
- nestedEntity: any
- nestedEntityKeyAttribute: any
- nestedEntityName: any
- onChangeDirty: any
- onValidation: any
- order: any
- phantom: any
- processedDefaultValue: any
- readOnly: any
- revert: any
- rights: any
- serialize: any
- setCustomPropertyValue: any
- setDeepDirty: any
- setDirty: any
- setPhantomCascade: any
- setReactive: any
- setReactiveCascade: any
- setReferencesChanged: any
- setTypeValue: any
- typeCategory: any
- typeValue: any
- updateDeepDirty: any
- updateDirty: any
- updateModelDirty: any
- validate: any
Implementation of IMetaComplexAttribute.getHasOneOriginalCollection
Inherited from AbstractAttribute.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[]
Implementation of IMetaComplexAttribute.getLogicErrors
Inherited from AbstractAttribute.getLogicErrors
- Defined in app-sdk/index.d.ts:423

getModelDirty

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

getPhantom

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

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

getPrimaryKeyValue

getPrimaryKeyValue(): string
Returns the primary key value

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

`Protected`getPropertiesAsMapByDescriptors

getPropertiesAsMapByDescriptors<T>(descriptors): {
    [key in
        | "name"
        | "defaultValue"
        | "hidden"
        | "revert"
        | "order"
        | "readOnly"
        | "isEditable"
        | "nestedEntityName"
        | "minCount"
        | "maxCount"
        | "nestedEntityKeyAttribute"
        | "nestedEntity"
        | "getAvailableTypeCategories"
        | "displayName"
        | "description"
        | "customProperties"
        | "rights"
        | "typeCategory"
        | "typeValue"
        | "clearTypeValues"
        | "getCustomProperty"
        | "getCustomPropertyJsonValue"
        | "setCustomPropertyValue"
        | "setTypeValue"
        | "processedDefaultValue"
        | "isIndexable"
        | "isReadable"
        | "isCreatable"
        | "modelId"
        | "phantom"
        | "dirty"
        | "onChangeDirty"
        | "onValidation"
        | "getLogicErrors"
        | "getField"
        | "getCollection"
        | "getFields"
        | "getFieldsMap"
        | "getHasManyMap"
        | "getHasOneMap"
        | "getFieldMainDescriptors"
        | "getFieldMainDescriptor"
        | "getFieldJsonDescriptor"
        | "getHasOneCollection"
        | "getHasOneMainDescriptors"
        | "getHasOneMainDescriptor"
        | "getHasOneJsonDescriptor"
        | "getHasOneOriginalCollection"
        | "getHasManyCollection"
        | "getHasManyMainDescriptors"
        | "getHasManyMainDescriptor"
        | "getHasManyJsonDescriptor"
        | "getPrimaryKeyValue"
        | "serialize"
        | "commit"
        | "setReactiveCascade"
        | "validate"
        | "checkFieldDirty"
        | "calculateFieldsDirty"
        | "isEqual"
        | "updateModelDirty"
        | "updateDeepDirty"
        | "updateDirty"
        | "getDirty"
        | "getPhantom"
        | "getValidationResult"
        | "clearValidationResult"
        | "setPhantomCascade"
        | "setDirty"
        | "getReferencesChanged"
        | "setReferencesChanged"
        | "getDeepDirty"
        | "getModelDirty"
        | "setDeepDirty"
        | "calculateDirty"
        | "calculateModelDirty"
        | "calculateDeepDirty"
        | "clone"
        | "getErrorMessage"
        | "setReactive"]?: ModelProperty<ComplexAttribute, 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<ComplexAttribute, T>[]
Returns {
    [key in
        | "name"
        | "defaultValue"
        | "hidden"
        | "revert"
        | "order"
        | "readOnly"
        | "isEditable"
        | "nestedEntityName"
        | "minCount"
        | "maxCount"
        | "nestedEntityKeyAttribute"
        | "nestedEntity"
        | "getAvailableTypeCategories"
        | "displayName"
        | "description"
        | "customProperties"
        | "rights"
        | "typeCategory"
        | "typeValue"
        | "clearTypeValues"
        | "getCustomProperty"
        | "getCustomPropertyJsonValue"
        | "setCustomPropertyValue"
        | "setTypeValue"
        | "processedDefaultValue"
        | "isIndexable"
        | "isReadable"
        | "isCreatable"
        | "modelId"
        | "phantom"
        | "dirty"
        | "onChangeDirty"
        | "onValidation"
        | "getLogicErrors"
        | "getField"
        | "getCollection"
        | "getFields"
        | "getFieldsMap"
        | "getHasManyMap"
        | "getHasOneMap"
        | "getFieldMainDescriptors"
        | "getFieldMainDescriptor"
        | "getFieldJsonDescriptor"
        | "getHasOneCollection"
        | "getHasOneMainDescriptors"
        | "getHasOneMainDescriptor"
        | "getHasOneJsonDescriptor"
        | "getHasOneOriginalCollection"
        | "getHasManyCollection"
        | "getHasManyMainDescriptors"
        | "getHasManyMainDescriptor"
        | "getHasManyJsonDescriptor"
        | "getPrimaryKeyValue"
        | "serialize"
        | "commit"
        | "setReactiveCascade"
        | "validate"
        | "checkFieldDirty"
        | "calculateFieldsDirty"
        | "isEqual"
        | "updateModelDirty"
        | "updateDeepDirty"
        | "updateDirty"
        | "getDirty"
        | "getPhantom"
        | "getValidationResult"
        | "clearValidationResult"
        | "setPhantomCascade"
        | "setDirty"
        | "getReferencesChanged"
        | "setReferencesChanged"
        | "getDeepDirty"
        | "getModelDirty"
        | "setDeepDirty"
        | "calculateDirty"
        | "calculateModelDirty"
        | "calculateDeepDirty"
        | "clone"
        | "getErrorMessage"
        | "setReactive"]?: ModelProperty<ComplexAttribute, T, any>
}
Implementation of IMetaComplexAttribute.getPropertiesAsMapByDescriptors
Inherited from AbstractAttribute.getPropertiesAsMapByDescriptors
- Defined in app-sdk/index.d.ts:456

`Protected`getPropertiesByDescriptors

getPropertiesByDescriptors<T>(descriptors): ModelProperty<ComplexAttribute, 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<ComplexAttribute, T>[]
Returns ModelProperty<ComplexAttribute, T, any>[]
Implementation of IMetaComplexAttribute.getPropertiesByDescriptors
Inherited from AbstractAttribute.getPropertiesByDescriptors
- Defined in app-sdk/index.d.ts:452

`Protected`getPropertyByDescriptor

getPropertyByDescriptor<T>(descriptor): undefined | ModelProperty<ComplexAttribute, 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<ComplexAttribute, T>
Returns undefined | ModelProperty<ComplexAttribute, T, any>
Implementation of IMetaComplexAttribute.getPropertyByDescriptor
Inherited from AbstractAttribute.getPropertyByDescriptor
- Defined in app-sdk/index.d.ts:447

getReferencesChanged

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

getValidationResult

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

isEqual

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

revert

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

serialize

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

setCustomPropertyValue

setCustomPropertyValue(key, value): void
Parameters
- key: string
- value: any
Returns void
Implementation of IMetaComplexAttribute.setCustomPropertyValue
Inherited from AbstractAttribute.setCustomPropertyValue
- Defined in app-sdk/index.d.ts:38

setDeepDirty

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

setDirty

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

setReferencesChanged

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

setTypeValue

setTypeValue(typeCategory, value): void
Parameters
- typeCategory: AttributeTypeCategory
- value: null | string
Returns void
Inherited from AbstractAttribute.setTypeValue
- Defined in app-sdk/index.d.ts:40

updateDeepDirty

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

updateDirty

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

updateModelDirty

updateModelDirty(): void
Returns void
Implementation of IMetaComplexAttribute.updateModelDirty
Inherited from AbstractAttribute.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 IMetaComplexAttribute.validate
Inherited from AbstractAttribute.validate
- Defined in app-sdk/index.d.ts:569

`Static`compareAttributes

compareAttributes(a, b): -1 | 0 | 1
Parameters
- a: AbstractAttribute<any>
- b: AbstractAttribute<any>
Returns -1 | 0 | 1
Inherited from AbstractAttribute.compareAttributes
- Defined in app-sdk/index.d.ts:43

`Static`dictionaryTypeValueValidate

dictionaryTypeValueValidate(model?): boolean
Parameters
- Optionalmodel: AbstractAttribute<any>
Returns boolean
Inherited from AbstractAttribute.dictionaryTypeValueValidate
- Defined in app-sdk/index.d.ts:42

`Static`typeCategoryValidate

typeCategoryValidate(model?): boolean
Parameters
- Optionalmodel: AbstractAttribute<any>
Returns boolean
Inherited from AbstractAttribute.typeCategoryValidate
- Defined in app-sdk/index.d.ts:41

Class ComplexAttribute

Public

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ComplexAttribute

Properties

customProperties

defaultValue

description

dirty

displayName

hidden

maxCount

minCount

modelId

name

nestedEntity

nestedEntityKeyAttribute

nestedEntityName

ProtectedobservabilitySet

onChangeDirty

onValidation

order

phantom

readOnly

rights

ProtectedvalidationResult

StaticdefaultInitData

Accessors

isCreatable

Returns boolean

isEditable

Returns boolean

isIndexable

Returns boolean

isReadable

Returns boolean

processedDefaultValue

Returns any

typeCategory

Returns null | AttributeTypeCategory

typeValue

Returns | undefined | ARRAY_DATA_TYPE | CODE_DATA_TYPE | SIMPLE_DATA_TYPE

Methods

ProtectedafterInit

Returns void

ProtectedbeforeInit

Returns void

calculateDeepDirty

Returns boolean

calculateDirty

Returns boolean

calculateFieldsDirty

Returns boolean

calculateModelDirty

Returns boolean

checkFieldDirty

Parameters

Returns boolean

clearTypeValues

Parameters

Returns void

clearValidationResult

Returns void

clone

Type Parameters

Parameters

Returns T

commit

Returns void

ProtectedcommitFields

Returns void

`Protected`observabilitySet

`Protected`validationResult

`Static`defaultInitData

Returns
| undefined
| ARRAY_DATA_TYPE
| CODE_DATA_TYPE
| SIMPLE_DATA_TYPE

`Protected`afterInit

`Protected`beforeInit

`Protected`commitFields

`Protected`commitHasMany

`Protected`commitHasOne

`Protected`createFields

`Protected`createHasMany

`Protected`createHasOne

Returns {
defaultValue: any;
description: any;
displayName: any;
hidden: any;
maxCount: any;
minCount: any;
name: any;
nestedEntityKeyAttribute: any;
nestedEntityName: any;
order: any;
processedDefaultValue: any;
readOnly: any;
}