Search
    Preparing search index...

    Interface IRecordArrayAttribute

    Интерфейс массив-атрибута записи

    interface IRecordArrayAttribute {
        dirty: boolean;
        hidden: BooleanField;
        modelId: number;
        name: StringField;
        observabilitySet: Set<ReactiveProp>;
        onChangeDirty: ModelDirtyChangeHandler;
        onValidation: (_validationResult: IValidationResult) => void;
        phantom: boolean;
        setHidden: (isHidden: boolean) => void;
        type: EnumField<SIMPLE_DATA_TYPE>;
        validationResult: IValidationResult;
        value: ModelCollection<any>;
        get isHidden(): boolean;
        get isValueEmpty(): boolean;
        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;
        getDeepDirty(): boolean;
        getDirty(): boolean;
        getErrorMessage(validatorName: string): string;
        getField(name: string): undefined | AbstractField<any, BaseOptions>;
        getFieldJsonDescriptor(
            propertyName: string,
        ):
            | undefined
            | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>;
        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,
        ): undefined | ClassPropertyDescriptor<any, ModelCollection<any>>;
        getHasManyMainDescriptor(
            propertyName: string,
        ): ClassPropertyDescriptor<any, ModelCollection<any>>;
        getHasManyMainDescriptors(): ClassPropertyDescriptor<
            any,
            ModelCollection<any>,
        >[];
        getHasManyMap(): { [key: string]: any };
        getHasOneCollection(): any[];
        getHasOneJsonDescriptor(
            propertyName: string,
        ): undefined | ClassPropertyDescriptor<any, AbstractModel<any>>;
        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>,
        ): undefined | ModelProperty<any, T, any>;
        getReferencesChanged(): boolean;
        getValidationResult(level?: number): Map<string, string[]>;
        isEqual(model: AbstractModel<any>, config?: EqualConfig): boolean;
        revert(): void;
        serialize(
            config?: SerializationConfig,
        ): Partial<Pick<GetTypes<any>, string>>;
        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;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    dirty hidden modelId name observabilitySet onChangeDirty onValidation phantom setHidden type validationResult value

    Accessors

    isHidden isValueEmpty

    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

    Properties

    dirty: boolean

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

    hidden: BooleanField

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

    Следует использовать setHidden и isHidden

    @universe-platform/record 2.0.0

    modelId: number

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

    name: StringField

    Имя атрибута

    observabilitySet: Set<ReactiveProp>
    onChangeDirty: ModelDirtyChangeHandler

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

    onValidation: (_validationResult: IValidationResult) => void

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

    phantom: boolean

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

    setHidden: (isHidden: boolean) => void

    Метод, устанавливающий флаг скрытности атрибута

    Type declaration

      • (isHidden: boolean): void

      • Parameters

        • isHidden: boolean

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

        Returns void

    type: EnumField<SIMPLE_DATA_TYPE>

    Тип атрибута

    validationResult: IValidationResult
    value: ModelCollection<any>

    Коллекция значений массив-атрибута

    Accessors

    • get isHidden(): boolean

      Геттер, определяющий является ли атрибут скрытым

      Returns boolean

    • get isValueEmpty(): boolean

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

      Returns boolean

    Methods

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

      Returns void

    • The method calls before the model initialization begins

      Returns void

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

      Returns boolean

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

      Returns boolean

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

      Returns boolean

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

      Type Parameters

      Parameters

      • OptionalincludeSystemProps: boolean

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

      Returns T

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

      Returns void

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

      Parameters

      • name: string

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

      Returns any

    • Получение значения dirty

      Returns boolean

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

      Parameters

      • validatorName: string

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

      Returns string

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

      Returns any[]

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

      Returns { [key: string]: any }

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

      Returns { [key: string]: any }

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

      Returns { [key: string]: any }

    • Возвращает массив оригинальной hasOne

      Returns { [key: string]: any }

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

      Returns string[]

    • Получение параметра phantom

      Returns boolean

    • Возвращает значение первичного ключа

      Returns string

    • Получение флага, отвечающего за referencesChanged

      Returns boolean

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

      Parameters

      • Optionallevel: number

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

      Returns Map<string, string[]>

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

      Returns void

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

      Parameters

      • flag: boolean

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

      Returns void

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

      Parameters

      • flag: boolean

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

      Returns void

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

      Parameters

      • phantom: boolean

      Returns void

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

      Parameters

      • props: ReactiveProp[]

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

      Returns void

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

      Parameters

      • props: ReactiveProp[]

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

      Returns void

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

      Parameters

      • flag: boolean

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

      Returns void

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

      Parameters

      • OptionaldisablePropagation: boolean

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

      Returns IValidationResult

    On This Page

    Properties
    Accessors
    Methods
    afterInitbeforeInitcalculateDeepDirtycalculateDirtycalculateFieldsDirtycalculateModelDirtycheckFieldDirtyclearValidationResultclonecommitcommitFieldscommitHasManycommitHasOnecreateFieldscreateHasManycreateHasOnegetCollectiongetDeepDirtygetDirtygetErrorMessagegetFieldgetFieldJsonDescriptorgetFieldMainDescriptorgetFieldMainDescriptorsgetFieldsgetFieldsMapgetHasManyCollectiongetHasManyJsonDescriptorgetHasManyMainDescriptorgetHasManyMainDescriptorsgetHasManyMapgetHasOneCollectiongetHasOneJsonDescriptorgetHasOneMainDescriptorgetHasOneMainDescriptorsgetHasOneMapgetHasOneOriginalCollectiongetLogicErrorsgetModelDirtygetPhantomgetPrimaryKeyValuegetPropertiesAsMapByDescriptorsgetPropertiesByDescriptorsgetPropertyByDescriptorgetReferencesChangedgetValidationResultisEqualrevertserializesetDeepDirtysetDirtysetPhantomCascadesetReactivesetReactiveCascadesetReferencesChangedupdateDeepDirtyupdateDirtyupdateModelDirtyvalidate