Changes for page Интерфейс bim

Last modified by Bimit Administrator on 02.10.2024, 09:47

From 71.1 to 72.1 From 73.8 to 73.9

From version 72.1

edited by Bimit Administrator
on 18.07.2023, 10:17

Change comment: There is no comment for this version

To version 73.8

edited by Bimit Administrator
on 21.06.2024, 13:47

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,31 +1,68 @@
  Основной интерфейс для получения и работы с данными. В данном интерфейсе доступны следующие методы:
--* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
--* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
--* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
--* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
--* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
--* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задач
--* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задач
--* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
++* [[calculateDuty>>path:#_Toc66]] - получение номера дежурной группы
++* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
++* [[createCondition>>path:#_Toc40]] - функция создания условия поиска элементов по параметру поиска, оператору сравнения
++* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
++* [[getAmountDate>>path:#_Toc62]] - получение даты через указанное количество дней
++* [[getAttachmentDrawing>>path:#_Toc32]] - получение байтового массива с чертежом вложенного к задаче по названию чертежа
++* [[getAttachmentImage>>path:#_Toc31]] - получение изображения вложенного к задаче по названию изображения
++* [[getAvatar>>path:#_Toc33]] - получение байтового массива аватара по его имени
++* [[getCollisionsForReport>>path:#_Toc26]] - функция получения списка коллизий для отчета
++* [[getDate>>path:#_Toc63]] - получение даты из строки
++* [[getDateTime>>path:#_Toc64]] - получение даты и времени из строки
  * [[getElement>>path:#_Toc9]] - функция получения полной информации о элементе
++* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
++* [[getEndDate>>path:#_Toc61]] - получение даты на конец следующего дня
++* [[getFilesDownloadLinks>>path:#_Toc27]] - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
++* [[getFirstEscalationTasks>>path:#_Toc58]] - получение списка просроченных задач
  * [[getGeometryElement>>path:#_Toc10]] - функция получения полной информации о элементе и дополнительно параметры геометрии
--* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
--* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
--* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
  * [[getGeometryElementA>>path:#_Toc14]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона А, если существует)
  * [[getGeometryElementB>>path:#_Toc15]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона B, если существует)
++* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
++* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
  * [[getGeometryObject>>path:#_Toc22]] - функция получения координат элемента для формирования объемной модели или отрисовки на экране
++* [[getGeometryObjects>>path:#_Toc38]] - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
++* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
++* [[getHtmlAvatar>>path:#_Toc34]] - получение аватара преобразованного к виду htlm строки (кода) по имени аватара
++* [[getHtmlDrawing>>path:#_Toc36]] - получение чертежа преобразованного к виду html строки (кода) по имени чертежа
++* [[getHtmlImage>>path:#_Toc35]] - получение изображения преобразованную к виду html строки (кода) по имени изображения
++* [[getMaintenanceTasks>>path:#_Toc55]] - получение списка задач ТО по списку идентификаторов
++* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
++* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
++* [[getOrCreateTaskFromMaintenance>>path:#_Toc54]] - создание или получение задачи на запланированное ТО по идентификатору задачи
++* [[getOrgGroup>>path:#_Toc53]] - получение группы организации
++* [[getOrgGroups>>path:#_Toc52]] - получение списка групп организации
++* [[getParamsToTask>>path:#_Toc45]] - получение списка параметров для задачи по идентификатору задачи
++* [[getProcessStatuses>>path:#_Toc42]] - получение списка пользовательских статусов для активного рабочего пространства
++* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
++* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
++* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
++* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
++* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
++* [[getSecondEscalationTasks>>path:#_Toc59]] - получить список задач второй эскалации
++* [[getStartDate>>path:#_Toc60]] - получение даты на начало следующего дня
++* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задач
++* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задач
++* [[getTaskForm>>path:#_Toc29]] - получение списка данных формы задачи по идентификатору задачи
++* [[getTaskParams>>path:#_Toc46]] - получение списка параметров для всех задач рабочего пространства
++* [[getTaskWorkers>>path:#_Toc30]] - получение списка профилей у задачи по её идентификатору
++* [[initPluginTaskStatus>>path:#_Toc67]] - инициализация пользовательских статусов в проекте
++* [[registerProcessStatuses>>path:#_Toc41]] - регистрация списка пользовательских статусов для задач по списку статусов задач плагина
++* [[saveParamsToTask>>path:#_Toc43]] - сохранение списка пользовательских параметров к задаче, на вход ей можно подать: идентификатор задачи, параметры, показ задачи
++* [[saveTask>>path:#_Toc65]] - создание и/или сохранение задачи
++* [[setGroupResponderToTask>>path:#_Toc57]] - назначение группы организации как ответственного на задачу по идентификатору задачи, имени группы
++* [[setGroupWorkersToTask>>path:#_Toc56]] - назначение группы организации как работника на задачу по идентификатору задачи, списку титулов
++* [[setPluginStatusToTask>>path:#_Toc50]] - изменение пользовательского статуса задачи по идентификатору задачи, статусу
  * [[showElements>>path:#_Toc16]] - функция отображения на экране списка элементов (выбор/подсветка на модели)
--* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
  * [[showGroupElements>>path:#_Toc18]] - функция отображения/подсветки на экране ранее созданных групп элементов
--* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
--* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
--* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
--* [[getCollisionsForReport>>path:#_Toc26]] - функция получения списка коллизий для отчета
--* [[getFilesDownloadLinks>>path:#_Toc27]] - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
++* [[deleteDutyShift>>path:#_Toc51]] - удаление назначенной группы к задаче, название которой содержит указанную строку
++* [[deleteParam>>path:#_Toc48]] - удаление параметра задачи по параметру идентификатора
++* [[deleteParams>>path:#_Toc49]] - удаление параметров
++* [[editParam>>path:#_Toc47]] - редактирование параметра задачи по идентификатору параметра, имени параметра, параметру
  * [[editTokenExpiredDate>>path:#_Toc28]] - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
++
  Справочники
  * [[Операторы сравнения>>path:#_Toc23]]
@@ -2382,8 +2382,482 @@
  {{/code}}
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc29"/}}getTaskForm** - получение списка данных формы задачи по идентификатору задачи
++)))
++* **bim.getTaskForm(UUID taskUuid) **
++**Пример использования:**
++
++{{code language="java"}}{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc30"/}}getTaskWorkers** - получение списка профилей у задачи по её идентификатору
++)))
++
++* **bim.getTaskWorkers(UUID taskUuid) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++% class="box infomessage" %)
++(((
++**{{id name="_Toc31"/}}getAttachmentImage** - получение изображения вложенного к задаче по названию изображения
++)))
++
++* **bim.getAttachmentImage(String imageName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc32"/}}getAttachmentDrawing** - получение байтового массива с чертежом вложенного к задаче по названию чертежа
++)))
++
++* **bim.getAttachmentDrawing(String drawingName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc33"/}}getAvatar** - получение байтового массива аватара по его имени
++)))
++
++* **bim.getAvatar(String avatarName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc34"/}}getHtmlAvatar** - получение аватара преобразованного к виду htlm строки (кода) по имени аватара
++)))
++
++* **bim.getHtmlAvatar(String avatarName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc35"/}}getHtmlImage** - получение изображения преобразованную к виду html строки (кода) по имени изображения
++)))
++
++* **bim.getHtmlImage(String imageName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc36"/}}getHtmlDrawing** - получение чертежа преобразованного к виду html строки (кода) по имени чертежа
++)))
++
++* **bim.getHtmlDrawing(String drawingName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc38"/}}getGeometryObjects** - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
++)))
++
++* **bim.getGeometryObjects(LogicGroup logicGroup) ** - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране, на вход ей можно подать: условие поиска, сложное условие поиска
++* **bim.getGeometryObjects(Collection<Object> elements) ** - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc40"/}}createCondition** - функция создания условия поиска элементов по параметру поиска, оператору сравнения
++)))
++
++* **bim.createCondition(String axis, String operators)) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc41"/}}registerProcessStatuses** - регистрация списка пользовательских статусов для задач по списку статусов задач плагина
++)))
++
++* **bim.registerProcessStatuses(List<PluginTaskStatus> statusList) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc42"/}}getProcessStatuses** - получение списка пользовательских статусов для активного рабочего пространства
++)))
++
++* **bim.getProcessStatuses() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc43"/}}saveParamsToTask** - сохранение списка пользовательских параметров к задаче
++)))
++
++* **bim.saveParamsToTask(UUID taskUuid, Map<String, Object> params, boolean showInTask) ** - сохранение списка пользовательских параметров к задаче, на вход ей можно подать: идентификатор задачи, параметры, показ задачи
++* **bim.saveParamsToTask(UUID taskUuid, String name, Object value, boolean showInTask) ** - сохранение пользовательского параметра к задаче, на вход ей можно подать: идентификатор задачи, имя задачи, какое-то значение, показ задачи
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc45"/}}getParamsToTask** - получение списка параметров для задачи по идентификатору задачи
++)))
++
++* **bim.getParamsToTask(UUID taskUuid) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc46"/}}getTaskParams** - получение списка параметров для всех задач рабочего пространства
++)))
++
++* **bim.getTaskParams() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc47"/}}editParam** - редактирование параметра задачи по идентификатору параметра, имени параметра, параметру
++)))
++
++* **bim.editParam(UUID paramUuid, String name, Object param) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc48"/}}deleteParam** - удаление параметра задачи по параметру идентификатора
++)))
++
++* **bim.deleteParam(UUID paramUuid) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc49"/}}deleteParams** - удаление параметров
++)))
++
++* **bim.deleteParams(UUID taskUuid) ** - удаление параметров у задачи по идентификатору задачи
++* **bim.deleteParams(List<PluginTaskParam> params) ** - удаление списка параметров
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc50"/}}setPluginStatusToTask** - изменение пользовательского статуса задачи по идентификатору задачи, статусу
++)))
++
++* **bim.setPluginStatusToTask(UUID taskUuid, String status) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc51"/}}deleteDutyShift** - удаление назначенной группы к задаче, название которой содержит указанную строку
++)))
++
++* **bim.deleteDutyShift(Task task, String groupName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc52"/}}getOrgGroups** - получение списка групп организации
++)))
++
++* **bim.getOrgGroups() ** - получение списка групп организации
++* **bim.getOrgGroups(List<UUID> orgGroups) ** - получение списка групп организации по идентификаторам
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc53"/}}getOrgGroup** - получение группы организации
++)))
++
++* **bim.getOrgGroup(UUID orgGroup) ** - получение группы организации по её идентификатору
++* **bim.getOrgGroup(String groupName) ** - получение группы организации по её названию
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc54"/}}getOrCreateTaskFromMaintenance** - создание или получение задачи на запланированное ТО по идентификатору задачи
++)))
++
++* **bim.getOrCreateTaskFromMaintenance(UUID maintenanceTask) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc55"/}}getMaintenanceTasks** - получение списка задач ТО по списку идентификаторов
++)))
++
++* **bim.getMaintenanceTasks(List<UUID> taskUuids) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc56"/}}setGroupWorkersToTask** - назначение группы организации как работника на задачу по идентификатору задачи, списку титулов
++)))
++
++* **bim.setGroupWorkersToTask(UUID taskUuid, List<String> titles) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc57"/}}setGroupResponderToTask** - назначение группы организации как ответственного на задачу по идентификатору задачи, имени группы
++)))
++
++* **bim.setGroupResponderToTask(UUID taskUuid, String groupName) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc58"/}}getFirstEscalationTasks** - получение списка просроченных задач
++)))
++
++* **bim.getFirstEscalationTasks() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc59"/}}getSecondEscalationTasks** - получить список задач второй эскалации
++)))
++
++* **bim.getSecondEscalationTasks() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc60"/}}getStartDate** - получение даты на начало следующего дня
++)))
++
++* **bim.getStartDate() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc61"/}}getEndDate** - получение даты на конец следующего дня
++)))
++
++* **bim.getEndDate() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc62"/}}getAmountDate** - получение даты через указанное количество дней
++)))
++
++* **bim.getAmountDate(int day) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc63"/}}getDate** - получение даты из строки
++)))
++
++* **bim.getDate(String dateStr) ** - получение даты из строки
++* **bim.getDate(String dateStr, String formatStr) ** - получение даты из строки по заданному формату
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc64"/}}getDateTime** - получение даты и времени из строки
++)))
++
++* **bim.getDateTime(String dateStr) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc65"/}}saveTask** - создание и/или сохранение задачи
++)))
++
++* **bim.saveTask(Task task) **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc66"/}}calculateDuty** - получение номера дежурной группы
++)))
++
++* **bim.calculateDuty() ** - получение номера дежурной группы на следующий день
++* **bim.calculateDuty(String groupName) ** - получение номера дежурной группы на следующий день по имени группы
++* **bim.calculateDuty(MaintenanceTask mTask) ** - получение номера дежурной группы  на дату проведени ТО по задаче обслуживания
++* **bim.calculateDuty(String groupName, MaintenanceTask mTask) ** - получение номера группы на дату проведени ТО по имени группы, задаче обслуживания
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc67"/}}initPluginTaskStatus** - инициализация пользовательских статусов в проекте
++)))
++
++* **bim.initPluginTaskStatus() **
++
++**Пример использования:**
++
++{{code language="java"}}
++
++{{/code}}
++
++
  СПРАВОЧНИКИ