Юниверс DG SDK UI
v2.15.0

Интерфейс IMetaComplexAttribute

Интерфейс, описывающий комплексный мета-атрибут

interface IMetaComplexAttribute {
    customProperties: ModelCollection<
        Universe.Platform.CustomProperty.CustomProperty,
    >;
    defaultValue: StringField<null>;
    description: StringField;
    dirty: boolean;
    displayName: StringField;
    generationStrategy?: any;
    hidden?: BooleanField<void>;
    isIndexable: boolean;
    isReadable: boolean;
    maxCount: IntegerField<null>;
    minCount: IntegerField;
    modelId: number;
    name: StringField;
    nestedEntity: IMetaModel | null;
    nestedEntityKeyAttribute: StringField<null>;
    nestedEntityName: StringField;
    nullable?: BooleanField<void>;
    observabilitySet: Set<ReactiveProp>;
    onChangeDirty: ModelDirtyChangeHandler;
    onValidation: (_validationResult: IValidationResult) => void;
    order: IntegerField;
    phantom: boolean;
    rights?: Right | null;
    typeCategory?: AttributeTypeCategory | null;
    validationResult: IValidationResult;
    valueGenerationStabilityType?: EnumField<GENERATION_STABILITY, null>;
    valueGenerationStable?: BooleanField<void>;
    get processedDefaultValue(): any;
    get typeValue(): | ARRAY_DATA_TYPE
    | CODE_DATA_TYPE
    | SIMPLE_DATA_TYPE
    | undefined;
    afterInit(): void;
    beforeInit(): void;
    calculateDeepDirty(): boolean;
    calculateDirty(): boolean;
    calculateFieldsDirty(): boolean;
    calculateModelDirty(): boolean;
    checkFieldDirty(field: AbstractField<any>): boolean;
    clearValidationResult(): void;
    clone<T extends AbstractModel<any>>(includeSystemProps?: boolean): T;
    commit(): void;
    commitFields(): void;
    commitHasMany(): void;
    commitHasOne(): void;
    createFields(data: any): void;
    createHasMany(data: any, initConfig: Partial<ModelOptions>): void;
    createHasOne(data: any, initConfig: Partial<ModelOptions>): void;
    getCollection(name: string): any;
    getCustomProperty(
        key: string,
    ): Universe.Platform.CustomProperty.CustomProperty | null;
    getCustomPropertyJsonValue(key: string): any;
    getDeepDirty(): boolean;
    getDirty(): boolean;
    getErrorMessage(validatorName: string): string;
    getField(name: string): AbstractField<any, BaseOptions> | undefined;
    getFieldJsonDescriptor(
        propertyName: string,
    ):
        | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
        | undefined;
    getFieldMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>;
    getFieldMainDescriptors(): ClassPropertyDescriptor<
        any,
        AbstractField<any, BaseOptions>,
    >[];
    getFields(): any[];
    getFieldsMap(): { [key: string]: any };
    getHasManyCollection(): any[];
    getHasManyJsonDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, ModelCollection<any>> | undefined;
    getHasManyMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, ModelCollection<any>>;
    getHasManyMainDescriptors(): ClassPropertyDescriptor<
        any,
        ModelCollection<any>,
    >[];
    getHasManyMap(): { [key: string]: any };
    getHasOneCollection(): any[];
    getHasOneJsonDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractModel<any>> | undefined;
    getHasOneMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractModel<any>>;
    getHasOneMainDescriptors(): ClassPropertyDescriptor<
        any,
        AbstractModel<any>,
    >[];
    getHasOneMap(): { [key: string]: any };
    getHasOneOriginalCollection(): { [key: string]: any };
    getLogicErrors(): string[];
    getModelDirty(): boolean;
    getPhantom(): boolean;
    getPrimaryKeyValue(): string;
    getPropertiesAsMapByDescriptors<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptors: ClassPropertyDescriptor<any, T>[],
    ): { [key in string]?: ModelProperty<any, T, any> };
    getPropertiesByDescriptors<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptors: ClassPropertyDescriptor<any, T>[],
    ): ModelProperty<any, T, any>[];
    getPropertyByDescriptor<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptor: ClassPropertyDescriptor<any, T>,
    ): ModelProperty<any, T, any> | undefined;
    getReferencesChanged(): boolean;
    getValidationResult(level?: number): Map<string, string[]>;
    isEqual(model: AbstractModel<any>, config?: EqualConfig): boolean;
    revert(): void;
    serialize(config?: SerializationConfig): SerializedType<Ch>;
    setCustomPropertyValue(key: string, value: string): void;
    setDeepDirty(flag: boolean): void;
    setDirty(flag: boolean): void;
    setPhantomCascade(phantom: boolean): void;
    setReactive(props: ReactiveProp[]): void;
    setReactiveCascade(props: ReactiveProp[]): void;
    setReferencesChanged(flag: boolean): void;
    updateDeepDirty(): void;
    updateDirty(): void;
    updateModelDirty(): void;
    validate(disablePropagation?: boolean): IValidationResult;
}

Иерархия (Просмотр сводки)

Реализован в

Индекс

Свойства

Дополнительные параметры атрибута

defaultValue: StringField<null>

Значение атрибута по умолчанию

description: StringField

Описание атрибута

dirty: boolean

Является ли модель измененной

displayName: StringField

Отображаемое имя модели

generationStrategy?: any

Стратегия автогенерации значения атрибута

hidden?: BooleanField<void>

Является ли атрибут скрытым

isIndexable: boolean

Является ли атрибут индексируемым

isReadable: boolean

Имеет ли пользователь права на чтение атрибута

maxCount: IntegerField<null>

Максимальное количество атрибутов

minCount: IntegerField

Минимальное количество атрибутов

modelId: number

Идентификатор модели

Имя модели

nestedEntity: IMetaModel | null

Вложенный объект

nestedEntityKeyAttribute: StringField<null>

Ключевой атрибут вложенного объекта

nestedEntityName: StringField

Внутреннее имя вложенного объекта

nullable?: BooleanField<void>

Может ли атрибут быть незаполненным

observabilitySet: Set<ReactiveProp>

Хендлер изменения параметра dirty

onValidation: (_validationResult: IValidationResult) => void

Хендлер в момент валидации модели

Порядок отображения относительно других атрибутов

phantom: boolean

Является ли модель еще не опубликованной

rights?: Right | null

Права пользователя, связанные с данным атрибутом

typeCategory?: AttributeTypeCategory | null

Категория типов атрибута

validationResult: IValidationResult
valueGenerationStabilityType?: EnumField<GENERATION_STABILITY, null>

Тип стабильности генерации значения

valueGenerationStable?: BooleanField<void>

Включена ли стабильность генерации значения

Акцессоры

  • get processedDefaultValue(): any

    Значение атрибута по умолчанию, используемое при создании дата-атрибута

    Возвращает any

Методы

  • This method is called at the final stage of model initialization

    Возвращает void

  • The method calls before the model initialization begins

    Возвращает void

  • Метод, который вычисляет и возвращает флаг deepDirty

    Возвращает boolean

  • Метод получение любого активного флага dirty

    Возвращает boolean

  • Метод, который вычисляет и возвращает флаг изменения модели

    Возвращает boolean

  • Клонирование модели

    Параметры типа

    Параметры

    • OptionalincludeSystemProps: boolean

      параметр, отвечающий за сохранение системных параметров модели

    Возвращает T

  • Запись изменений в модель

    Возвращает void

  • Метод получения коллекции ключей

    Параметры

    • name: string

      Имя коллекции, которое нужно получить

    Возвращает any

  • Метод, возвращающий десериализованное значение дополнительного параметра атрибута

    Параметры

    • key: string

      Имя доп. параметра

    Возвращает any

  • Получить сообщение об ошибки, после валидации

    Параметры

    • validatorName: string

      имя валидатора, у которого нужно получить сообщение об ошибке

    Возвращает string

  • Возвращает массив полей модели

    Возвращает any[]

  • Возвращает коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Возвращает hasMany коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Возвращает hasOne коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Этот метод вызывается при валидации. Если в модели есть логические ошибки, то здесь будет приведен их список

    Возвращает string[]

  • Получение результата валидации

    Параметры

    • Optionallevel: number

      уровень ошибок, который должен вернуться

    Возвращает Map<string, string[]>

  • Отмена изменений в моделе

    Возвращает void

  • Метод, устанавливающий значение дополнительного параметра атрибута

    Параметры

    • key: string

      Имя доп. параметра

    • value: string

    Возвращает void

  • Изменение флага deepDirty

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Изменение фала dirty

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Устанавливает атрибут phantom каскадно для модели

    Параметры

    • phantom: boolean

    Возвращает void

  • Делает некоторые системные свойства реактивными в текущей модели.

    Параметры

    • props: ReactiveProp[]

      Список системных свойств.

    Возвращает void

  • Делает некоторые свойства системы реактивными, создавай каскад по всей модели

    Параметры

    • props: ReactiveProp[]

      список системных свойств

    Возвращает void

  • Изменение флага referencesChanged

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Метод проверки модели

    Параметры

    • OptionaldisablePropagation: boolean

      Флаг уведомления родительского компонента о проверке

    Возвращает IValidationResult