Документация для разработчиков
Темная тема

IBPWorkflowDocument

Класс документа должен реализовывать методы интерфейса IBPWorkflowDocument. Этот интерфейс содержит методы, которые необходимы бизнес-процессу для работы с документом.

Для того чтобы бизнес-процесс мог работать с каким-либо объектом, необходимо выбрать, что будет являться документом, что будет являться типом документа, какие будут идентификаторы у документа и типа документа. Кроме того нужно реализовать класс документа в соответствии с интерфейсом IBPWorkflowDocument.

Тип документа и документ определяются своими идентификаторами, которые имеют вид кортежа из трех элементов: кода модуля, имени класса документа и некоторого кода (как правило, кода элемента). Подробнее смотрите статью Документ.

Методы

НазваниеОписаниеС версии
CanUserOperateDocumentМетод проверяет права на выполнение операций над заданным документом.8.5
CanUserOperateDocumentTypeМетод проверяет права на выполнение операций над документами заданного типа 8.5
CreateDocumentМетод создает новый документ с указанными свойствами (полями) и возвращает его код. 8.5
DeleteDocumentМетод удаляет указанный документ. 8.5
GetAllowableOperationsМетод для типа документа возвращает массив доступных операций. 8.5
GetAllowableUserGroupsМетод для типа документа возвращает массив возможных групп пользователей. 8.5
GetDocumentМетод возвращает свойства (поля) документа в виде ассоциативного массива. 8.5
GetDocumentAdminPageМетод по коду документа возвращает ссылку на страницу документа в административной части. 8.5
GetDocumentFieldsМетод возвращает массив свойств (полей), которые имеет документ данного типа. 8.5
GetDocumentForHistoryМетод возвращает массив произвольной структуры, содержащий всю информацию о документе. 8.5
GetUsersFromUserGroupМетод возвращает пользователей указанной группы для указанного документа в виде массива кодов пользователей. 8.5
IsDocumentLocked Метод проверяет, заблокирован ли указанный документ для указанного бизнес-процесса. 8.5
LockDocumentМетод блокирует указанный документ для указанного бизнес-процесса. 8.5
PublishDocumentМетод публикует документ, то есть делает его доступным в публичной части сайта. 8.5
RecoverDocumentFromHistoryМетод восстанавливает указанный документ из массива. 8.5
UnlockDocumentМетод разблокирует указанный документ. 8.5
UnpublishDocumentМетод снимает документ с публикации, то есть делает его недоступным в публичной части сайта. 8.5
UpdateDocumentМетод изменяет свойства (поля) указанного документа на указанные значения. 8.5


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх