Java-класс BoFieldDto
Хранит настройки поля БО. Он используется из BoDto.
| Поле | Тип | Описание | ||
|---|---|---|---|---|
| kind | BusinessFieldKind | Вид поля Есть бизнес-объекты, которые связаны с системными объектами. Например "Пользователи", которые хранятся в {@link PersonDto}. И есть поля, которые ассоциированы с этим системным объектом. Данное значение указывает на какое поле в системном объекте ссылается данное поле бизнес-объекта Значение BusinessFieldKind.GENERAL показывает, что данное поле бизнес-объекта не связанно ни с каким полем системного объекта, и храниться как обычное поле бизнес-объекта |
||
| label | String | Отображаемое наименование поля | ||
| labelEng | String | Отображаемое наименование поля | ||
| labelKaz | String | Отображаемое наименование поля | ||
| labelQaz | String | Отображаемое наименование поля | ||
| defaultValue | String | Значение по умолчанию - оно присваивается в форме при создании инстанции бизнес-объекта | ||
| defaultValueEng | String | Значение по умолчанию - оно присваивается в форме при создании инстанции бизнес-объекта | ||
| defaultValueKaz | String | Значение по умолчанию - оно присваивается в форме при создании инстанции бизнес-объекта | ||
| defaultValueQaz | String | Значение по умолчанию - оно присваивается в форме при создании инстанции бизнес-объекта | ||
| code | String | Код поля, который используется в скриптах и Rest-API Если не указан, то берётся label через транслитерацию |
||
| type | BoFieldType | Тип поля | ||
| boFieldIds | Map<BoFieldId, Integer> | Список ссылок на поля БО, которые являются ассоциированными с этим составным полем. Это поле используется составным объектом. Типы этих полей должны быть равны type Ключ колоды - ссылка на поле бизнес-объекта с помощью класса BoFieldId Значение колоды - всегда 1 |
||
| options | Map<String optionId, BoFieldOption> | Опции, которые есть варианты выбора в поле Ключ колоды - идентификатор выбора Value колоды - данные выбора, хранимые в классе BoFieldOption |
||
| tabs | Map<String tabId, BoFieldTab> | Определяет набор вкладов на форме. Используется только для поля с типом BoFieldType.TAB_GROUP |
||
| tabId | String | Идентификатор вкладки, в которой находиться данное поле. Их искать нужно среди полей типа BoFieldType.TAB_GROUP данного БО в поле tabs | ||
| isRequired | Boolean | Признак обязательности заполнения этого поля | ||
| isAppendable | Boolean | Этот флаг используется для полей типа BoFieldType.CHECKLIST Если это поле true, то во время использования поля бизнес-объекта можно дополнять и удалять опции. Если это поле false, то во время использования поля бизнес-объекта можно менять только галочки. |
||
| isRequiredAll | Boolean | Используется для типа type = CHECKBOX_GROUP Если isRequiredAll = true, то нужно проставить пользователю все галочки из options Если isRequiredAll = false, то нужно смотреть на isRequired Если isRequired = true, то нужно поставить хотя бы одну галочку из options Иначе - поле заполнять не обязательно |
||
| isReadonly | Boolean | Поле только для чтения | ||
| isClickable | Boolean | Используется для BoFieldType.BO Признак, позволяющий открывать карточку инстанции вложенного БО |
||
| isSelectOnly | Boolean | Поля для выбора, без редактирования | ||
| isUnique | Boolean | Признак уникальности данного поля бизнес-объекта. Если true - то данное поле уникально и по нему создаётся уникальный индекс в БД Mongo | ||
| isSeparated | Boolean | Числовое Поле для разделения числа на разряды | ||
| isHeightDynamic | Boolean | Используется для BoFieldType.BO, .CO Признак того, что высота поля динамичная |
||
| hideLabel | Boolean | Признак, позволяющий скрывать заголовок поля | ||
| textCase | TextFieldCase | Признак, позволяющий определить регистр текстового поля. Используется для BoFieldType.INPUT_TEXT Если testCase = TextFieldCase.UPPER, то текстовое поле принимает только заглавные буквы Если testCase = TextFieldCase.LOWER, то текстовое поле принимает только строчные буквы По дефолту, testCase = TextFieldCase.NONE, текстовое поле принимает буквы любого регистра |
||
| tableWidth | Integer | Поле, позволяющее изменять ширину столбцов в реестре | ||
| needAddToParticipants | Boolean | Поле которое говорит добавлять ли в участники пользователя или не добавлять, во вложенном объекте пользователя | ||
| maxLength | Integer | Используется для BoFieldType.INPUT_TEXT и BoFieldType.INPUT_NUMBER Максимальное количество символов, которое может быть в этом поле. Если равен null, значит ограничении нет |
||
| trackedFieldId | String | Поле которое говорит связанно ли оно с календарем для отслеживания статуса Это поле используется только если type == BoFieldType.DROPDOWN_SINGLE |
||
| needShowToCalendar | Boolean | Поле которое говорит использовать ли поле для построения календаря | ||
| dateOnlyFuture | Boolean | Признак того, что поля с типом дата выбираются только на будущее время от текущего Это поле используется только если .type == BoFieldType.FULL_DATE или BoFieldType.DATE или BoFieldType.YEAR или BoFieldType.YEAR_AND_MONTH или BoFieldType.PERIOD или BoFieldType.PERIOD_TIME и .dateOnlyPast == false |
||
| dateOnlyPast | Boolean | Признак того, что поля с типом дата выбираются только на прошедшее время от текущего Это поле используется только если .type == BoFieldType.FULL_DATE или BoFieldType.DATE или BoFieldType.YEAR или BoFieldType.YEAR_AND_MONTH или BoFieldType.PERIOD или BoFieldType.PERIOD_TIME и .dateOnlyFuture == false |
||
| unacceptableValue | boolean | Признак сохранения значение поля. Если true - то значение сохранено не будет, в противном случае значение поля сохраняется | ||
| needTrackStatus | Boolean | Поле которое говорит отслеживать ли статус для инстанции | ||
| chosenAccessRight | boolean | Признак того что настройки поля бизнес объекта отличаются от заводских настроек | ||
| refBoId | ObjectId | ИД бизнес-объекта, на который ссылается данное поле Это поле используется только если .type == BoFieldType.BO, BoFieldType.CO, BoFieldType.DROPDOWN_SINGLE, BoFieldType.RADIO_BUTTON_GROUP |
||
| linkedFieldId | String | ИД поля бизнес-объекта, которое связано с данным полем Это поле используется только если .type == BoFieldType.BO |
||
| linkedCoSettings | Map<String boId, LinkedCoSettingDto> | Набор ИД бизнес объекта и поля бизнес-объекта, которое связано с данным полем Ключ колоды - ИД бизнес объекта, value колоды - LinkedCoSettingDto Это поле используется только если .type == BoFieldType.CO |
||
| fieldRefs | Map<String fieldId, FieldRef> | Это ссылки на поля бизнес-объекта с ИД = .refBoId Ключ колоды - ИД поля, value колоды - FieldRef Это поле используется только если .type == BoFieldType.BO |
.type == BoFieldType.CO | |
| viewType | BoFieldViewType | Способ отображения данного поля на форме Это поле используется только если .type == BoFieldType.BO |
||
| tableColOrderIndex | Integer | Порядок отображения данного поля в списке инстанций БО | ||
| tableColToShow | Boolean | Отображать ли это поле в списке инстанций БО | ||
| groupingInfo | GroupingInfo | Находится ли поле в дереве группировки. Отображать ли это поле в таблице на странице группировки | ||
| gantTableLocations | Map< |
Список расположений этого поля в таблицах диаграммы ган-та Ключ колоды - идентификатор поля с типом BoFieldType.PERIOD, по которому строится таблица Значение колоды - расположение поля в таблице: GantTableLocationDto |
||
| isHistoryTracking | Boolean | Отображать ли события при изменении поля | ||
| isKindAddForSelect | Boolean | Добавлять ли новую инстанцию | ||
| isSystem | boolean | Признак системности данного поля | ||
| isCodeReadonly | boolean | Признак кода поля для чтения | ||
| filterFieldConnectIds | Map< |
Связи данного поля с другими полями других бизнес-объектов. Эти бизнес-объекты используются для фильтрации значений данного поля бизнес-объекта в инстанции, по принципу наличия подобных значений в указываемых полях других инстанций, которые ссылаются на данную инстанцию по любому полю Используется только, если .type == BoFieldType.BO Указываемые поля тоже должны иметь тип BoFieldType.BO Ключом колоды является значение BoFieldId.strValue() Value колоды всегда является 1 |
||
| accessGroupId | ObjectId | Идентификатор объекта прав доступа на это поле - равен AccessGroupDto.id | ||
| filterId | ObjectId | ИД фильтра бизнес-объекта BoFilterDto.id | ||
| bracketFilterId | ObjectId | ИД фильтра бизнес-объекта BracketFilterDto.id | ||
| gridPosition | GridPosition | Позиция поля | ||
| params | Map<String paramName, String paramValue> | Дополнительные параметры, которые клиент может использовать по своему собственному усмотрению | ||
| createdAt | Date | Когда создано поле | ||
| createdBy | ObjectId -> PersonDto | Кем создано поле | ||
| titleOrderIndex | Integer | Порядок использования данного поля во время формирования отображаемого имени инстанции | ||
| titleToShow | Boolean | Используется ли это поле во время формирования отображаемого имени инстанции | ||
| optionSource | OptionSource | Источник заполнения опции (вариантов) | ||
| relMainInnerFieldId | String | Используется для связи полей. Связь создаётся только если .type == BoFieldType.BO. Id поля по которому нужно производить фильтрацию |
||
| relFieldId | String | Используется для связи полей. Связь создаётся только если .type == BoFieldType.BO. Id поля из которого берётся значение для фильтрации |
||
| relInnerFieldId | String | Используется для связи полей. Связь создаётся только если .type == BoFieldType.BO. Id внутреннего поля из которого берётся значение для фильтрации, когда {@link #relFieldId} ссылается на Бизнес Объект. (Не обязателен к заполнению) |
||
| needLoadFromInTables | boolean | Признак того, что данное поле загружается из in-таблиц при миграции | ||
| useAsKeyInMigration | boolean | Данный признак указывает, что данное поле должно быть использовано как ключ определения записи при in-migration. Это поле должно быть только типа INPUT_TEXT |
||
| needUploadToOutTable | boolean | Признак того, что данное поле выгружается в out-таблицы при миграции | ||
| inMigrationTimezoneMinutes | Long | Поле которое говорит какую временную зону ставить при миграции Это поле используется только если .type == BoFieldType.FULL_DATE или BoFieldType.DATE или BoFieldType.YEAR или BoFieldType.YEAR_AND_MONTH или BoFieldType.TIME |
||
| needChangeParentBoByLinkedBo | boolean | Признак того, что создание вложенных инстанций будет зависеть от сохранение родительской инстанции | ||
| needFreezeWhenScroll | boolean | Поле которое после скроллинга, остается на верхний части в инстанций, до следующего такого поля | ||
| needMarkNew | boolean | Поле которое говорит нужно ли помечать новые записи, и учитывать их при сортировке Это поле используется только если .type == BoFieldType.BO или BoFieldType.CO |
||
| copyFromFieldId | String | Используется для копирования значения из указанного поля при изменении его значения. Настройка копирования возможна только если у текущего поля .type == BoFieldType.BO и у поля с которого нужно копировать значения тоже .type == BoFieldType.BO Так-же значения копируются только когда у текущего поля и у поля с которого нужно копировать похожие варианты отображения. (множественный == множественный или одиночный == одиночный) |
||
| removeType | BoFieldRemoveType | Признак того, как будут отображаться удаленные инстанции вложенного БО | ||
| dictionaryOptionSetting | Map<String dictionaryCode, FromBoOptionSetting> | Настройки опции для кан-ба-на, используется только при BoFieldDto.optionSource == FROM_BO Ключ колоды - код инстанции БО справочника с ИД BoFieldDto.refBoId Value колоды - данные выбора, хранимые в классе FromBoOptionSetting |
||
| questionnaires | Map<String questionnaireId, QuestionnaireDto> | Опросник, которые содержит колонки и строки Ключ колоды - идентификатор колонки или опросника Value колоды - данные выбора, хранимые в классе QuestionnaireDto |
||
| questionnaireIsMultiple | Boolean | Признак того, что опросник имеет возможность множественного выбора | ||
| staticValue | String | Поля статичного текста | ||
| staticValueEng | String | Поля статичного текста | ||
| staticValueKaz | String | Поля статичного текста | ||
| staticValueQaz | String | Поля статичного текста | ||
| isProgressBarSticky | Boolean | (описания нету) |