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-2024, «1С-Битрикс», 2024