api.web Ссылка на иерархическое дерево в веб-интерфейсе

Ссылка на иерархическое дерево на отдельной странице

api.web.content(linkDefinition)

Генерация ссылки на контент на отдельной странице.

Возвращает ссылку на контент на отдельной странице в соответствии с параметрами, переданными в linkDefinition. Этот объект создается с помощью методов, предусмотренных для отдельных контентов, например, "Иерархическое дерево".
api.web.defineHierarchyGridLink()

Создает и возвращает билдер для ссылки на контент типа "Иерархическое дерево".

Пример. Генерация ссылки на иерархическое дерево на основе шаблона с кодом templateHG по структуре с кодом orgstruct. В дереве активирована фокусировка со скрытием, оно доступно только профилю operator. Ссылка действительна в течение 30 дней:
Copy
```
def linkDefinition = api.web.defineHierarchyGridLink()
.setTemplate('templateHG')
.setStructureCode('orgstruct')
.setObjectFocusMode('FOCUS_WITH_HIDDEN')
.setDaysToLive(30)
.setProfiles(['operator']);
def link = api.web.content(linkDefinition);
```

Методы билдера

Общие методы билдера

setUsers — строка, содержащая UUID пользователей, которым доступна страница. Необязательный метод, по умолчанию значение пусто и страница с иерархическим деревом доступна всем пользователям с учетом ограничения по профилям.
setDaysToLive — продолжительность жизни ссылки в днях. Необязательный метод, по умолчанию берутся из параметра файле dbaccess.properties. Если значение в dbaccess.properties неуказано, то оно равно 30 дням

Методы билдера для иерархического дерева

setTemplate (template) — строка, содержащая код шаблона контента, которому будет соответствовать отображение полученного иерархического дерева. Необязательный метод.
setTitle — заголовок страницы с иерархическим деревом.
setProfiles(List<String> profiles) — список кодов профилей, которым доступен контент. Переопределяет соответствующий параметр из шаблона.
setContextFqn(Object contextFqn) — FQN класса/тип объекта окружающего контекста. Если задан совместно с шаблоном, должен совпадать со значением из шаблона.
setObject(Object object) — Задает объект окружающего контекста. Если в шаблоне или через параметр задан класс/тип объекта контекста, то переданный объект должен иметь этот же либо унаследованный тип.

Поддерживается конструкция currentUser по аналогии со списками на отдельной странице, см. api.web Ссылка на список на карточке объекта в веб-интерфейсе.
setStructureCode(String structureCode) — код структуры иерархического дерева в виде строки. Обязательный параметр. Если шаблон задан, структура из шаблона должна совпадать с указанной в качестве параметра метода.
setBuildHierarchyFromCurrentObject(boolean buildHierarchyFromCurrentObject) — признак необходимости построения дерева от текущего объекта. Переопределяет соответствующий параметр из шаблона.
setObjectFocusMode(String objectFocusMode) — тип фокусировки на объекте контекста. Переопределяет соответствующий параметр из шаблона.

Возможные значения:
- OFF — выключено;
- FOCUS_WITH_HIDDEN — фокусировка со скрытием;
- FOCUS_WITHOUT_HIDDEN — фокусировка без скрытия.