Interface IUPathAttribute

Public

interface IUPathAttribute {
    dirty: boolean;
    displayName: StringField<void>;
    modelId: number;
    name: StringField<void>;
    observabilitySet: Set<ReactiveProp>;
    onChangeDirty: (() => void);
    onValidation: ((_validationResult: IValidationResult) => void);
    phantom: boolean;
    validationResult: IValidationResult;
    afterInit(): void;
    beforeInit(): void;
    calculateDeepDirty(): boolean;
    calculateDirty(): boolean;
    calculateFieldsDirty(): boolean;
    calculateModelDirty(): boolean;
    checkFieldDirty(field: AbstractField<any, BaseOptions>): boolean;
    clearValidationResult(): void;
    clone<T>(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(): {};
    getHasManyCollection(): any[];
    getHasManyJsonDescriptor(propertyName: string): undefined | ClassPropertyDescriptor<any, ModelCollection<any>>;
    getHasManyMainDescriptor(propertyName: string): ClassPropertyDescriptor<any, ModelCollection<any>>;
    getHasManyMainDescriptors(): ClassPropertyDescriptor<any, ModelCollection<any>>[];
    getHasManyMap(): {};
    getHasOneCollection(): any[];
    getHasOneJsonDescriptor(propertyName: string): undefined | ClassPropertyDescriptor<any, AbstractModel<any>>;
    getHasOneMainDescriptor(propertyName: string): ClassPropertyDescriptor<any, AbstractModel<any>>;
    getHasOneMainDescriptors(): ClassPropertyDescriptor<any, AbstractModel<any>>[];
    getHasOneMap(): {};
    getHasOneOriginalCollection(): {};
    getLogicErrors(): string[];
    getModelDirty(): boolean;
    getPhantom(): boolean;
    getPrimaryKeyValue(): string;
    getPropertiesAsMapByDescriptors<T>(descriptors: ClassPropertyDescriptor<any, T>[]): {
        [key in string]?: ModelProperty<any, T, any>
    };
    getPropertiesByDescriptors<T>(descriptors: ClassPropertyDescriptor<any, T>[]): ModelProperty<any, T, any>[];
    getPropertyByDescriptor<T>(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 full)

Properties

dirty displayName modelId name observabilitySet onChangeDirty onValidation phantom validationResult

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

dirty: boolean

displayName

displayName: StringField<void>

modelId

modelId: number

name

name: StringField<void>

ProtectedobservabilitySet

observabilitySet: Set<ReactiveProp>

onChangeDirty

onChangeDirty: (() => void)

onValidation

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

phantom

phantom: boolean

ProtectedvalidationResult

validationResult: IValidationResult

Methods

ProtectedafterInit

  • afterInit(): void

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

    Returns void

ProtectedbeforeInit

  • beforeInit(): void

  • The method calls before the model initialization begins

    Returns void

calculateDeepDirty

calculateDirty

calculateFieldsDirty

calculateModelDirty

checkFieldDirty

clearValidationResult

clone

  • clone<T>(includeSystemProps?): T

  • Cloning model data

    Type Parameters

    Parameters

    • OptionalincludeSystemProps: boolean

      phantom, dirty, original values

    Returns T

    T

commit

ProtectedcommitFields

ProtectedcommitHasMany

ProtectedcommitHasOne

ProtectedcreateFields

  • createFields(data): void

  • Creates model fields

    Parameters

    • data: any

    Returns void

ProtectedcreateHasMany

ProtectedcreateHasOne

getCollection

getDeepDirty

getDirty

getErrorMessage

getField

getFieldJsonDescriptor

getFieldMainDescriptor

getFieldMainDescriptors

getFields

  • getFields(): any[]

  • Returns an array of model fields

    Returns any[]

getFieldsMap

getHasManyCollection

getHasManyJsonDescriptor

getHasManyMainDescriptor

getHasManyMainDescriptors

getHasManyMap

getHasOneCollection

getHasOneJsonDescriptor

getHasOneMainDescriptor

getHasOneMainDescriptors

getHasOneMap

getHasOneOriginalCollection

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[]

getModelDirty

getPhantom

  • getPhantom(): boolean

  • Returns whether a new record is selected

    Returns boolean

getPrimaryKeyValue

ProtectedgetPropertiesAsMapByDescriptors

ProtectedgetPropertiesByDescriptors

ProtectedgetPropertyByDescriptor

getReferencesChanged

getValidationResult

  • getValidationResult(level?): Map<string, string[]>

  • Parameters

    • Optionallevel: number

    Returns Map<string, string[]>

isEqual

revert

serialize

setDeepDirty

setDirty

setPhantomCascade

  • setPhantomCascade(phantom): void

  • Sets the phantom attribute cascadingly for the model

    Parameters

    • phantom: boolean

    Returns void

setReactive

  • setReactive(props): void

  • Make some of the system properties reactive in the current model

    Parameters

    Returns void

setReactiveCascade

  • setReactiveCascade(props): void

  • Make some of the system properties reactive cascading throughout the model

    Parameters

    Returns void

setReferencesChanged

updateDeepDirty

updateDirty

updateModelDirty

validate

On This Page

Properties
Methods
afterInitbeforeInitcalculateDeepDirtycalculateDirtycalculateFieldsDirtycalculateModelDirtycheckFieldDirtyclearValidationResultclonecommitcommitFieldscommitHasManycommitHasOnecreateFieldscreateHasManycreateHasOnegetCollectiongetDeepDirtygetDirtygetErrorMessagegetFieldgetFieldJsonDescriptorgetFieldMainDescriptorgetFieldMainDescriptorsgetFieldsgetFieldsMapgetHasManyCollectiongetHasManyJsonDescriptorgetHasManyMainDescriptorgetHasManyMainDescriptorsgetHasManyMapgetHasOneCollectiongetHasOneJsonDescriptorgetHasOneMainDescriptorgetHasOneMainDescriptorsgetHasOneMapgetHasOneOriginalCollectiongetLogicErrorsgetModelDirtygetPhantomgetPrimaryKeyValuegetPropertiesAsMapByDescriptorsgetPropertiesByDescriptorsgetPropertyByDescriptorgetReferencesChangedgetValidationResultisEqualrevertserializesetDeepDirtysetDirtysetPhantomCascadesetReactivesetReactiveCascadesetReferencesChangedupdateDeepDirtyupdateDirtyupdateModelDirtyvalidate