Class AliasCodeAttribute

Public

Hierarchy (view full)

AbstractAttribute
- AliasCodeAttribute

Index

Constructors

constructor

new AliasCodeAttribute(data, _descriptorConfig?, options?): AliasCodeAttribute
Parameters
- data: Partial<Pick<GetTypes<any>, string>>
- Optional_descriptorConfig: IStringKeyMap<any>
- Optionaloptions: Partial<ModelOptions>
Returns AliasCodeAttribute
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

displayable

displayable: BooleanField<void>

displayName

displayName: StringField<void>

hidden

hidden: BooleanField<void>

mainDisplayable

mainDisplayable: BooleanField<void>

modelId

modelId: number

name

name: StringField<void>

nullable

nullable: BooleanField<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

searchable

searchable: BooleanField<void>

searchCaseInsensitive

searchCaseInsensitive: BooleanField<void>

searchCustomSort

searchCustomSort: EnumField<AttributeSearchCustomSort, null>

searchMorphologically

searchMorphologically: BooleanField<void>

searchWithSynonyms

searchWithSynonyms: BooleanField<void>

searchWithTransliteration

searchWithTransliteration: BooleanField<void>

simpleDataType

simpleDataType: EnumField<CODE_DATA_TYPE, void>

unique

unique: BooleanField<void>

`Protected`validationResult

validationResult: IValidationResult

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
Inherited from AbstractAttribute.isIndexable
- Defined in app-sdk/index.d.ts:45

isReadable

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

processedDefaultValue

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

required

get required(): boolean
Returns boolean
- Defined in app-sdk/index.d.ts:1145

typeCategory

get typeCategory(): AttributeTypeCategory
Returns AttributeTypeCategory
Overrides AbstractAttribute.typeCategory
- Defined in app-sdk/index.d.ts:1146

typeValue

get typeValue(): CODE_DATA_TYPE
Returns CODE_DATA_TYPE
Overrides AbstractAttribute.typeValue
- Defined in app-sdk/index.d.ts:1147

Methods

`Protected`afterInit

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

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

calculateDeepDirty

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

calculateDirty

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

calculateFieldsDirty

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

calculateModelDirty

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

checkFieldDirty

checkFieldDirty(field): boolean
Parameters
- field: AbstractField<any, BaseOptions>
Returns boolean
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
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
Inherited from AbstractAttribute.clone
- Defined in app-sdk/index.d.ts:613

commit

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

`Protected`commitFields

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

`Protected`commitHasMany

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

`Protected`commitHasOne

commitHasOne(): void
Returns void
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
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
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
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:1148

getCollection

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

getCustomProperty

getCustomProperty(key): null | CustomProperty
Parameters
- key: string
Returns null | CustomProperty
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
Inherited from AbstractAttribute.getCustomPropertyJsonValue
- Defined in app-sdk/index.d.ts:37

getDeepDirty

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

getDirty

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

getErrorMessage

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

getFields

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

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

getFieldsMap

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

getHasManyCollection

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

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

getHasManyMap

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

getHasOneCollection

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

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

getHasOneMap

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

getHasOneOriginalCollection

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

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

getModelDirty

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

getPhantom

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

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

getPrimaryKeyValue

getPrimaryKeyValue(): string
Returns the primary key value

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

getReferencesChanged

getReferencesChanged(): boolean
Returns boolean
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[]>
Inherited from AbstractAttribute.getValidationResult
- Defined in app-sdk/index.d.ts:588

isEqual

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

revert

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

setCustomPropertyValue

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

setDeepDirty

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

setDirty

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

setReferencesChanged

setReferencesChanged(flag): void
Parameters
- flag: boolean
Returns void
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
Inherited from AbstractAttribute.updateDeepDirty
- Defined in app-sdk/index.d.ts:581

updateDirty

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

updateModelDirty

updateModelDirty(): void
Returns void
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
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 AliasCodeAttribute

Public

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AliasCodeAttribute

Properties

customProperties

defaultValue

description

dirty

displayable

displayName

hidden

mainDisplayable

modelId

name

nullable

ProtectedobservabilitySet

onChangeDirty

onValidation

order

phantom

readOnly

rights

searchable

searchCaseInsensitive

searchCustomSort

searchMorphologically

searchWithSynonyms

searchWithTransliteration

simpleDataType

unique

ProtectedvalidationResult

Accessors

isCreatable

Returns boolean

isEditable

Returns boolean

isIndexable

Returns boolean

isReadable

Returns boolean

processedDefaultValue

Returns any

required

Returns boolean

typeCategory

Returns AttributeTypeCategory

typeValue

Returns CODE_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

`Protected`observabilitySet

`Protected`validationResult

`Protected`afterInit

`Protected`beforeInit

`Protected`commitFields

`Protected`commitHasMany

`Protected`commitHasOne

`Protected`createFields

`Protected`createHasMany

`Protected`createHasOne