Search
    Preparing search index...

    Модель комплексного атрибута мета-модели

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

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

    defaultValue: StringField<null>

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

    description: StringField

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

    dirty: boolean

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

    displayName: StringField

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

    hidden: BooleanField

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

    maxCount: IntegerField<null>

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

    minCount: IntegerField

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

    modelId: number

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

    Внутреннее имя

    nestedEntity: null | NestedEntity

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

    nestedEntityKeyAttribute: StringField<null>

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

    nestedEntityName: StringField

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

    observabilitySet: Set<ReactiveProp>

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

    onValidation: (_validationResult: IValidationResult) => void

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

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

    phantom: boolean

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

    readOnly: BooleanField

    Находится ли атрибут в режиме только для чтения

    rights: null | Right

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

    validationResult: IValidationResult
    defaultInitData: IKeyValueMap<string>

    Рудимент, больше не используется в системе

    @universe-platform/meta 2.0.0

    Accessors

    • get isCreatable(): boolean

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

      Returns boolean

    • get isEditable(): boolean

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

      Returns boolean

    • get isIndexable(): boolean

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

      Returns boolean

    • get isReadable(): boolean

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

      Returns boolean

    • get processedDefaultValue(): any

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

      Returns any

    Methods

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

      Parameters

      Returns void

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

      Type Parameters

      Parameters

      • OptionalincludeSystemProps: boolean

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

      Returns T

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

      Parameters

      • validatorName: string

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

      Returns string

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

      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;
      }

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

      Returns { customProperties?: any; processedDefaultValue?: any }

    • Возвращает 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;
      }

    • Возвращает массив оригинальной 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;
      }

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

      Returns string[]

    • 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

      Parameters

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

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

      Parameters

      • Optionallevel: number

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

      Returns Map<string, string[]>

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

      Parameters

      • flag: boolean

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

      Returns void

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

      Parameters

      • typeCategory: AttributeTypeCategory

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

      • value: null | string

        Новое значение

      Returns void