<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > DocflowApproval – документооборот. Движение документов Клиентские функции модуля DocflowApproval |
![]() ![]() |
Имя функции |
Модификатор |
Атрибут |
Описание |
virtual |
[Public] |
Утвердить документ |
|
virtual |
– |
Создать поручение |
|
virtual |
– |
Подписать документы |
|
virtual |
[Public] |
Согласовать документ с приложениями |
|
– |
[Public] |
Получить сертификаты текущего пользователя для подписания документа |
|
virtual |
[Public] |
Получить подписанта на основе прав на утверждение замещающего и замещаемого |
|
– |
– |
Узнать, нужно ли показывать хинт о доступности сервиса обмена |
|
– |
[Public] |
Выбрать сертификат для подписания |
|
static |
– |
Показать диалог подтверждения выполнения без создания поручений |
|
– |
– |
Показать хинт о доступности сервиса обмена на событии изменения значения контрола |
|
virtual |
[Public] |
Подписать документ и приложения |
|
virtual |
[Public] |
Попытаться утвердить документ |
|
virtual |
[Public] |
Попытаться согласовать документ |
|
virtual |
– |
Согласовать документ |
|
virtual |
[Public] |
Попытаться подписать документ и приложения |
|
virtual |
– |
Проверить задание перед отправкой на доработку |
|
virtual |
– |
Проверить наличие сертификатов перед согласованием документа |
Утвердить документ.
Синтаксис
[Public]
public virtual bool ApproveDocument(IElectronicDocument document, ICertificate certificate, string comment, IEmployee signatory)
Параметры
document – Документ;
certificate – Сертификат;
comment – Комментарий к подписи;
signatory – Сотрудник, от чьего имени происходит подписание.
Возвращаемое значение
bool – True - если утверждение удалось, иначе - false.
Создать поручение.
Синтаксис
public virtual ITask CreateActionItemExecution(IOfficialDocument document, long parentAssignmentId)
Параметры
document – Документ, по которому создается поручение;
parentAssignmentId – ИД задания, от которого создается поручение.
Возвращаемое значение
ITask – Поручение.
Подписать документы.
Синтаксис
public virtual string EndorseDocuments(IElectronicDocument document, List<IElectronicDocument> addenda, IEmployee signatory, bool endorse, bool needStrongSignature, string signingComment)
Параметры
document – Документ;
addenda – Приложения к документу;
signatory – Подписант;
endorse – True - согласовать, False - не согласовать;
needStrongSignature – Требуется ли усиленная подпись;
signingComment – Комментарий при подписании.
Возвращаемое значение
string – Если подписание успешно - пустая строка, иначе - текст возникшей ошибки.
Согласовать документ с приложениями.
Синтаксис
[Public]
public virtual bool EndorseWithAddenda(IElectronicDocument mainDocument, List<IElectronicDocument> addenda, ICertificate certificate, IEmployee signatory, string comment)
Параметры
mainDocument – Документ;
addenda – Приложения;
certificate – Сертификат;
signatory – За кого выполняется согласование;
comment – Комментарий.
Возвращаемое значение
bool – True, если сам документ был согласован или не имеет версий. Факт согласования приложений неважен.
GetCurrentUsersCertificatesForSigning
Получить сертификаты текущего пользователя для подписания документа.
Синтаксис
[Public]
public List<ICertificate> GetCurrentUsersCertificatesForSigning(IElectronicDocument document)
Параметры
document – Подписываемый документ.
Возвращаемое значение
List<ICertificate> – Сертификаты для подписания документа.
Получить подписанта на основе прав на утверждение замещающего и замещаемого.
Синтаксис
[Public]
public virtual Company.IEmployee GetDocumentSignatory(IElectronicDocument document, IEmployee substitute, IEmployee signatory)
Параметры
document – Подписываемый документ;
substitute – Замещающий;
signatory – Подписант.
Возвращаемое значение
Company.IEmployee – Подписант, если права на подписание есть и у замещающего, и у подписанта, иначе замещающий.
Узнать, нужно ли показывать хинт о доступности сервиса обмена.
Синтаксис
public bool NeedShowExchangeHint(Domain.Shared.IPropertyState state, IMailDeliveryMethod deliveryMethod, Domain.Shared.ParamsDictionary param, IOfficialDocument document)
Параметры
state – Состояние свойства;
deliveryMethod – Сервис обмена;
param – Параметр, в котором хранится информация о необходимости показать хинт;
document – Документ, для которого проверяется доступность отправки через сервис обмена.
Возвращаемое значение
bool – Признак необходимости показать хинт. True - если нужно показать хинт, иначе - false.
Выбрать сертификат для подписания.
Синтаксис
[Public]
public ICertificate SelectCertificateForSigning(IElectronicDocument document, List<ICertificate> certificates)
Параметры
document – Подписываемый документ;
certificates – Список доступных сертификатов.
Возвращаемое значение
ICertificate – Выбранный сертификат для подписания.
ShowConfirmationDialogForCreatingActionItem
Показать диалог подтверждения выполнения без создания поручений.
Синтаксис
public static bool ShowConfirmationDialogForCreatingActionItem(IAssignment assignment, IOfficialDocument document, Sungero.Workflow.Client.ExecuteResultActionArgs e)
Параметры
assignment – Задание, которое выполняется;
document – Документ;
e – Аргументы.
Возвращаемое значение
bool – True, если диалог был, иначе false.
Показать хинт о доступности сервиса обмена на событии изменения значения контрола.
Синтаксис
public void ShowExchangeHint(Domain.Shared.IPropertyState state, Domain.Shared.IPropertyInfo info, IMailDeliveryMethod deliveryMethod, Sungero.Presentation.ValueInputEventArgs<IMailDeliveryMethod> e, IOfficialDocument document)
Параметры
state – Состояние свойства;
info – Информация о свойстве;
deliveryMethod – Сервис обмена;
e – Аргументы события Изменение значения контрола;
document – Документ, для которого проверяется доступность отправки через сервис обмена.
Подписать документ и приложения.
Синтаксис
[Public]
public virtual bool SignDocumentWithAddenda(IElectronicDocument mainDocument, List<IElectronicDocument> addenda, ICertificate certificate, string comment, IEmployee signatory)
Параметры
mainDocument – Документ;
addenda – Приложения;
certificate – Сертификат;
comment – Комментарий к подписи;
signatory – Сотрудник, от чьего имени происходит подписание.
Возвращаемое значение
bool – True - если подписание основного документа успешно, иначе - false.
Попытаться утвердить документ.
Синтаксис
[Public]
public virtual bool TryApproveDocument(IElectronicDocument document, ICertificate certificate, string comment, IEmployee signatory)
Параметры
document – Документ;
certificate – Сертификат;
comment – Комментарий к подписи;
signatory – Сотрудник, от чьего имени происходит подписание.
Возвращаемое значение
bool – True - если утверждение удалось, иначе - false.
Попытаться согласовать документ.
Синтаксис
[Public]
public virtual bool TryEndorseDocument(IElectronicDocument document, ICertificate certificate, string comment, IEmployee signatory)
Параметры
document – Документ;
certificate – Сертификат;
comment – Комментарий к подписи;
signatory – Сотрудник, от чьего имени происходит подписание.
Возвращаемое значение
bool – True - если согласование удалось, иначе - false.
Согласовать документ.
Синтаксис
public virtual string TryEndorseDocumentWithAddenda(IElectronicDocument document, List<IElectronicDocument> addenda, bool endorse, ICertificate certificate, Company.IEmployee signatory, string comment)
Параметры
document – Документ;
addenda – Приложения;
endorse – Признак согласования документа: True - согласовать документ, False - не согласовывать;
certificate – Сертификат;
signatory – Подписант;
comment – Комментарий.
Возвращаемое значение
string – Если подписание успешно - пустая строка, иначе - текст возникшей ошибки.
Попытаться подписать документ и приложения.
Синтаксис
[Public]
public virtual string TrySignDocumentWithAddenda(IElectronicDocument mainDocument, List<IElectronicDocument> addenda, ICertificate certificate, string comment, IEmployee signatory)
Параметры
mainDocument – Документ;
addenda – Приложения;
certificate – Сертификат;
comment – Комментарий к подписи;
signatory – Сотрудник, от чьего имени происходит подписание.
Возвращаемое значение
string – Если подписание успешно - пустая строка, иначе - текст возникшей ошибки.
Проверить задание перед отправкой на доработку.
Синтаксис
public virtual bool ValidateBeforeRework(Workflow.IAssignment assignment, Sungero.Domain.Client.ExecuteActionArgs eventArgs)
Параметры
assignment – Задание;
eventArgs – Аргументы действия.
Возвращаемое значение
bool – True - если ошибок нет, иначе - False.
ValidateCertificatesBeforeApproval
Проверить наличие сертификатов перед согласованием документа.
Синтаксис
public virtual string ValidateCertificatesBeforeApproval(ITask task, IElectronicDocument document, IEmployee approver)
Параметры
task – Задача на согласование;
document – Документ;
approver – Согласующий.
Возвращаемое значение
string – Если сертификаты найдены - пустая строка, иначе - текст ошибки об отсутствии сертификатов.
© Компания Directum, 2024 |