AddDeadlineHeaderToRight

Добавить в заголовок информацию о задержке выполнения.

Синтаксис

[Public]

public static void AddDeadlineHeaderToRight(Sungero.Core.StateBlock block, DateTime deadline, IUser user)

Параметры

block – Блок схемы;

deadline – Планируемый срок выполнения;

user – Исполнитель.

Addenda

Получить перечень приложений для шаблона документа.

Синтаксис

[Sungero.Core.Converter("Addenda")]

public static string Addenda(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

string – Перечень приложений.

AddOrUpdateEndorsementInfoInTracking

Добавить или обновить информацию о согласовании с контрагентом в выдаче документа.

Если в выдаче есть только строки с действием "Отправка контрагенту",

изменяем последнюю по дате выдачи запись на "Согласование с контрагентом".

Синтаксис

[Public]

public virtual void AddOrUpdateEndorsementInfoInTracking(long responsibleForReturnId, DateTime returnDeadline, ITask returnTask)

Параметры

responsibleForReturnId – ИД ответственного за возврат документа;

returnDeadline – Срок возврата;

returnTask – Задача возврата.

AddRegNumberValidationError

Синтаксис

public virtual void AddRegNumberValidationError(Sungero.Domain.BeforeSaveEventArgs e, Structures.OfficialDocument.RegNumberValidationResult validation)

Параметры

e

validation

AddUserActionBlock

Добавить блок информации о действии.

Синтаксис

[Public]

public static void AddUserActionBlock(object stateView, IUser user, string text, DateTime date, IEntity entity, string comment, IUser substituted)

Параметры

stateView – Схема представления;

user – Пользователь, выполнивший действие;

text – Текст действия;

date – Дата действия;

entity – Сущность, над которой было совершено действие;

comment – Примечание к действию;

substituted – Замещающий.

AutoNumbering

Синтаксис

public virtual void AutoNumbering(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

BUnitCode

Синтаксис

public virtual string BUnitCode()

BusinessUnitChanged

Синтаксис

public virtual bool BusinessUnitChanged()

CanChangeAssignee

Проверка, может ли текущий сотрудник менять поле "Исполнитель".

Синтаксис

[Remote(IsPure = true)]

public virtual bool CanChangeAssignee()

Возвращаемое значение

bool – True, если может.

CanConvertToPdfInteractively

Определить возможность интерактивной конвертации документа.

Синтаксис

[Remote]

public virtual bool CanConvertToPdfInteractively()

Возвращаемое значение

bool – True - возможно, False - иначе.

CanRegister

Синтаксис

public virtual bool CanRegister()

CanSendAnswer

Проверка возможности отправки ответа контрагенту через сервис обмена.

Синтаксис

[Public, Remote]

public virtual bool CanSendAnswer()

Возвращаемое значение

bool – True, если отправка ответа возможна, иначе - false.

CanSignByEmployee

Проверить наличие права подписи у сотрудника.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool CanSignByEmployee(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

bool – True, если сотрудник имеет право подписи, иначе - False.

CaseFileFiltering

Фильтрация дел для документа.

Синтаксис

[Public]

public virtual IQueryable<ICaseFile> CaseFileFiltering(IQueryable<ICaseFile> query)

Параметры

query – Исходные дела для документа.

Возвращаемое значение

IQueryable<ICaseFile> – Отфильтрованные дела для документа.

CaseIndex

Синтаксис

public virtual string CaseIndex()

CheckAllPropertiesFilled

Проверить что все свойства поручения заполнены.

Синтаксис

public virtual bool CheckAllPropertiesFilled(Structures.Module.IMinutesActionItem actionItemProperties)

Параметры

actionItemProperties – Список свойств поручения.

Возвращаемое значение

bool – True если все свойства заполнены, иначе False.

CheckPdfConvertibilityByExtension

Определить, поддерживается ли преобразование в PDF для переданного расширения.

Синтаксис

[Public]

public virtual bool CheckPdfConvertibilityByExtension(string extension)

Параметры

extension – Расширение.

Возвращаемое значение

bool – True, если поддерживается, иначе False.

CheckRegistrationNumberFormat

Синтаксис

public virtual string CheckRegistrationNumberFormat()

CheckSignatureRights

Синтаксис

public virtual void CheckSignatureRights(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

CompleteReturnTaskWithoutReturnControl

Синтаксис

public virtual string CompleteReturnTaskWithoutReturnControl(IOfficialDocumentTracking tracking)

Параметры

tracking

CompleteTasksByChangedTrackingRecord

Синтаксис

public virtual void CompleteTasksByChangedTrackingRecord(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ConvertToPdfAndAddRegistrationStamp

Преобразовать в PDF с отметкой о регистрации в новую версию документа.

Синтаксис

public virtual Structures.OfficialDocument.IConversionToPdfResult ConvertToPdfAndAddRegistrationStamp(long versionId, string registrationStamp, double rightIndent, double bottomIndent)

Параметры

versionId – ИД преобразуемой версии;

registrationStamp – Отметка о регистрации (html);

rightIndent – Значение отступа справа;

bottomIndent – Значение отступа снизу.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Информация о результате создания новой версии документа в PDF.

ConvertToPdfAndAddSignatureMark

Преобразовать документ в PDF и поставить отметку об ЭП.

Синтаксис

[Remote]

public virtual Structures.OfficialDocument.IConversionToPdfResult ConvertToPdfAndAddSignatureMark(long versionId)

Параметры

versionId – Id версии документа.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат преобразования в PDF.

ConvertToPdfWithMarks

Преобразовать документ в PDF с простановкой отметок.

Синтаксис

[Remote]

public virtual Structures.OfficialDocument.IConversionToPdfResult ConvertToPdfWithMarks(long versionId)

Параметры

versionId – ИД версии, на которую будут проставлены отметки.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат преобразования.

ConvertToPdfWithSignatureMark

Преобразовать документ в PDF с наложением отметки об ЭП.

Синтаксис

[Remote]

public virtual Structures.OfficialDocument.IConversionToPdfResult ConvertToPdfWithSignatureMark()

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат преобразования.

CopyAccessRightsToDocument

Скопировать права из текущего документа в указанный.

Синтаксис

[Public]

public virtual void CopyAccessRightsToDocument(IOfficialDocument document, Guid accessRightsLimit)

Параметры

document – Документ, в который копируются права;

accessRightsLimit – Максимальный тип прав, который может быть выдан. Guid.Empty, если устанавливать максимальный уровень прав не требуется.

CreateActionItemFromProperties

Создать поручение согласно списку свойств из протокола.

Синтаксис

public virtual RecordManagement.IActionItemExecutionTask CreateActionItemFromProperties(Structures.Module.IMinutesActionItem actionItemProperties)

Параметры

actionItemProperties – Список свойств поручения.

Возвращаемое значение

RecordManagement.IActionItemExecutionTask – Поручение.

CreateActionItemsFromDocument

Создать поручения по документу.

Синтаксис

[Remote, Public]

public virtual List<RecordManagement.IActionItemExecutionTask> CreateActionItemsFromDocument()

Возвращаемое значение

List<RecordManagement.IActionItemExecutionTask> – Список созданных поручений.

CreateAndStartCheckReturnTaskForDocument

Синтаксис

public virtual void CreateAndStartCheckReturnTaskForDocument(IOfficialDocumentTracking tracking)

Параметры

tracking

CreateCancellationAgreement

Создать соглашение об аннулировании.

Синтаксис

[Public, Remote]

public virtual Sungero.Docflow.Structures.OfficialDocument.ICancellationAgreementCreatingResult CreateCancellationAgreement(IEmployee ourSignatory, string reason)

Параметры

ourSignatory – Подписант НОР;

reason – Причина аннулирования.

Возвращаемое значение

Sungero.Docflow.Structures.OfficialDocument.ICancellationAgreementCreatingResult – Соглашение об аннулировании.

CreateConvertToPdfAndAddSignatureMarkAsyncHandler

Создать асинхронный обработчик для преобразования документа в PDF с отметкой об ЭП.

Синтаксис

[Public, Remote]

public virtual void CreateConvertToPdfAndAddSignatureMarkAsyncHandler(long versionId)

Параметры

versionId – ИД версии документа.

CreateNewTasks

Синтаксис

public virtual void CreateNewTasks(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

CreatePdfPublicBodyFromHtml

Создать PublicBody документа из html в формате pdf.

Синтаксис

[Public]

public virtual void CreatePdfPublicBodyFromHtml(string sourceHtml)

Параметры

sourceHtml – Исходный html.

CreateReplyDocument

Создать ответный документ.

Синтаксис

[Remote, Public]

public virtual Docflow.IOfficialDocument CreateReplyDocument()

Возвращаемое значение

Docflow.IOfficialDocument – Ответный документ.

CreateVersionWithRestoringExchangeState

Создать версию документа и восстановить прежний статус электронного обмена.

При создании версии чистится статус эл. обмена, восстанавливаем его.

Синтаксис

[Public]

public static void CreateVersionWithRestoringExchangeState(IOfficialDocument document)

Параметры

document – Документ.

DeleteDocument

Удалить документ.

Синтаксис

[Public, Remote]

public static void DeleteDocument(long documentId)

Параметры

documentId – ID документа.

DeleteRegistrationDateMark

Удалить отметку о дате регистрации документа.

Синтаксис

[Public, Remote]

public virtual void DeleteRegistrationDateMark()

DeleteRegistrationNumberMark

Удалить отметку о регистрационном номере документа.

Синтаксис

[Public, Remote]

public virtual void DeleteRegistrationNumberMark()

DeleteSignatureMark

Удалить отметку об электронной подписи документа.

Синтаксис

[Public, Remote]

public virtual void DeleteSignatureMark()

DeleteVersionMark

Удалить отметку документа.

Перегрузки

 

DeleteVersionMark (IMark mark)

Удалить отметку документа.

Синтаксис

[Public, Remote]

public virtual void DeleteVersionMark(IMark mark)

Параметры

mark – Отметка.

DeleteVersionMark (long versionId, string markKindSid)

Удалить отметку документа.

Синтаксис

[Public, Remote]

public virtual void DeleteVersionMark(long versionId, string markKindSid)

Параметры

versionId – ИД версии;

markKindSid – Sid вида отметки.

DepartmentChanged

Синтаксис

public virtual bool DepartmentChanged()

DepartmentCode

Синтаксис

public virtual string DepartmentCode()

DocumentTypeChanged

Синтаксис

public virtual bool DocumentTypeChanged()

DurationInWorkdays

Подсчет рабочих дней в промежутке времени.

Синтаксис

[Public]

public static int DurationInWorkdays(DateTime startDate, DateTime endDate, IUser user)

Параметры

startDate – Начало;

endDate – Окончание;

user – Пользователь.

Возвращаемое значение

int – Количество рабочих дней.

ExpandSignatoriesBySignatureSettings

Получить развернутый список подписывающих по правам подписи.

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

Синтаксис

public virtual List<long> ExpandSignatoriesBySignatureSettings(IQueryable<ISignatureSetting> settings)

Параметры

settings – Список прав подписи.

Возвращаемое значение

List<long> – Список ИД сотрудников.

ExtendTrackingDeadline

Обновить срок на вкладке "Выдача" документа.

Синтаксис

[Public]

public virtual void ExtendTrackingDeadline(DateTime newDeadline, ITask checkReturnTask)

Параметры

newDeadline – Новый срок;

checkReturnTask – Задача на контроль возврата.

FillActionItemExecutionTaskCommonProperties

Заполнение общих свойств поручения.

Синтаксис

public virtual void FillActionItemExecutionTaskCommonProperties(RecordManagement.IActionItemExecutionTask actionItem)

Параметры

actionItem – Поручение.

FillActionItemExecutionTaskOnCreatedFromDocument

Заполнение свойств поручения, созданного по документу.

Синтаксис

public virtual void FillActionItemExecutionTaskOnCreatedFromDocument(RecordManagement.IActionItemExecutionTask actionItem)

Параметры

actionItem – Поручение, созданное по документу.

FillActionItemProperty

Заполнить свойство поручения согласно значению свойства из протокола.

Синтаксис

public virtual void FillActionItemProperty(RecordManagement.IActionItemExecutionTask actionItem, string propertyName, string propertyValue)

Параметры

actionItem – Поручение;

propertyName – Имя свойства поручения из протокола;

propertyValue – Значение свойства поручения из протокола.

FillDocumentReturn

Синтаксис

public virtual void FillDocumentReturn(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

FillIssueToContractor

Синтаксис

public virtual void FillIssueToContractor(System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> tracking)

Параметры

tracking

FillIssueToEmployee

Синтаксис

public virtual void FillIssueToEmployee(System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> tracking)

Параметры

tracking

FillLocationState

Синтаксис

public virtual void FillLocationState()

FillPropertyStatus

Заполнить статус корректности распознавания для свойства.

Синтаксис

public virtual void FillPropertyStatus(Commons.IEntityRecognitionInfo recognitionInfo, string propertyName)

Параметры

recognitionInfo – Результат распознавания сущности;

propertyName – Имя свойства.

FillSentDate

Заполнить дату отправки.

Синтаксис

[Public]

public virtual void FillSentDate(ICounterparty correspondent)

Параметры

correspondent – Корреспондент.

FilterSignatories

Отфильтровать список подписантов, доступных для документа.

Синтаксис

[Public]

public virtual IQueryable<IEmployee> FilterSignatories(IQueryable<IEmployee> query)

Параметры

query – Список подписантов.

Возвращаемое значение

IQueryable<IEmployee> – Отфильтрованный список подписантов.

FixModifiedField

Синтаксис

public virtual void FixModifiedField(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ForChangedAssigneeCreateNewTask

Синтаксис

public virtual void ForChangedAssigneeCreateNewTask(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

FullName

Получить ФИО контакта для шаблона документа.

Перегрузки

 

FullName (IContact contact)

Получить ФИО контакта для шаблона документа.

Синтаксис

[Sungero.Core.Converter("FullName")]

public static PersonFullName FullName(IContact contact)

Параметры

contact – Контакт.

Возвращаемое значение

PersonFullName – ФИО контакта.

FullName (IEmployee employee)

Получить ФИО сотрудника для шаблона документа.

Синтаксис

[Sungero.Core.Converter("FullName")]

public static PersonFullName FullName(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

PersonFullName – ФИО сотрудника.

FullName (IPerson person)

Получить ФИО персоны для шаблона документа.

Синтаксис

[Sungero.Core.Converter("FullName")]

public static PersonFullName FullName(IPerson person)

Параметры

person – Персона.

Возвращаемое значение

PersonFullName – ФИО персоны.

GeneratePublicBodyWithSignatureMark

Сгенерировать PublicBody документа с отметкой об ЭП.

Синтаксис

public virtual Structures.OfficialDocument.IConversionToPdfResult GeneratePublicBodyWithSignatureMark(long versionId, string signatureMark)

Параметры

versionId – ИД версии для генерации;

signatureMark – Отметка об ЭП (html).

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Информация о результате генерации PublicBody для версии документа.

GenerateRegistrationPrefixAndPostfix

Синтаксис

public virtual void GenerateRegistrationPrefixAndPostfix(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

GetAcquaintanceTasks

Получить все задачи на ознакомление.

Синтаксис

[Public,  Remote(IsPure = true)]

public List<RecordManagement.IAcquaintanceTask> GetAcquaintanceTasks()

Возвращаемое значение

List<RecordManagement.IAcquaintanceTask> – Задачи на ознакомление с документом.

GetActionItemsExecutionTasks

Получить обновленный список поручений.

Синтаксис

[Remote]

public static List<RecordManagement.IActionItemExecutionTask> GetActionItemsExecutionTasks(List<long> ids)

Параметры

ids – Список Id поручений.

Возвращаемое значение

List<RecordManagement.IActionItemExecutionTask> – Обновленный список поручений.

GetActionItemsProperties

Получить свойства поручений из тела документа.

Синтаксис

public virtual List<Sungero.Docflow.Structures.Module.IMinutesActionItem> GetActionItemsProperties(System.IO.Stream stream)

Параметры

stream – Тело документа.

Возвращаемое значение

List<Sungero.Docflow.Structures.Module.IMinutesActionItem> – Список структур содержащих свойства поручений.

GetAllRecipientMembersIdsInGroup

Получить список Ид участников группы.

Синтаксис

[Public]

public static List<long> GetAllRecipientMembersIdsInGroup(long groupId)

Параметры

groupId – Ид группы.

Возвращаемое значение

List<long> – Список Ид участников.

GetApprovalRules

Получить правила согласования для документа.

Синтаксис

[Remote, Public]

public virtual List<IApprovalRuleBase> GetApprovalRules()

Возвращаемое значение

List<IApprovalRuleBase> – Правила согласования, доступные для документа в порядке убывания приоритета.

GetApprovalValidationErrors

Возвращает ошибки валидации подписания документа.

Синтаксис

[Remote(IsPure = true), Public]

public virtual List<string> GetApprovalValidationErrors(bool checkSignatureSettings)

Параметры

checkSignatureSettings – Проверять права подписи.

Возвращаемое значение

List<string> – Ошибки валидации.

GetAuthor

Получить автора задачи (автор, либо кто за кого выполнил).

Синтаксис

[Public]

public static string GetAuthor(IUser author, IUser startedBy)

Параметры

author – Автор;

startedBy – Выполнивший.

Возвращаемое значение

string – Фамилия инициалы автора, либо фамилия инициалы с учетом замещения.

GetAvailableAccessRights

Получить максимальный тип прав на документ, которые текущий пользователь может выдать.

Синтаксис

[Public]

public virtual Guid GetAvailableAccessRights()

Возвращаемое значение

Guid – Guid типа прав. Guid.Empty, если текущий пользователь не может выдавать права на документ.

GetBodyToConvertToPdf

Получить тело и расширение версии для преобразования в PDF с отметкой об ЭП.

Синтаксис

[Public]

public virtual Structures.OfficialDocument.IVersionBody GetBodyToConvertToPdf(Sungero.Content.IElectronicDocumentVersions version, bool isSignatureMark)

Параметры

version – Версия для генерации;

isSignatureMark – Признак отметки об ЭП. True - отметка об ЭП, False - отметка о поступлении.

Возвращаемое значение

Structures.OfficialDocument.IVersionBody – Тело версии документа и расширение.

GetBodyToConvertToPdfWithMarks

Получить тело и расширение версии для преобразования в PDF с отметками.

Синтаксис

public virtual Structures.OfficialDocument.IVersionBody GetBodyToConvertToPdfWithMarks(Sungero.Content.IElectronicDocumentVersions version)

Параметры

version – Версия для преобразования и простановки отметок.

Возвращаемое значение

Structures.OfficialDocument.IVersionBody – Тело и расширение версии документа.

GetBusinessUnitCEO

Получить руководителя НОР документа или сотрудника.

Синтаксис

public static IEmployee GetBusinessUnitCEO(IEmployee employee, IOfficialDocument document)

Параметры

employee – Сотрудник;

document – Документ. По нему определяется НОР. Если не указан, будет выбрана НОР сотрудника.

Возвращаемое значение

IEmployee – Подписывающий.

GetBusinessUnits

Получить наши организации для фильтрации подходящих прав подписи.

Синтаксис

public virtual List<IBusinessUnit> GetBusinessUnits()

Возвращаемое значение

List<IBusinessUnit> – Наши организации.

GetComparisonResults

Получить результаты сравнения документов.

Синтаксис

[Remote(IsPure = true)]

public virtual IQueryable<IDocumentComparisonInfo> GetComparisonResults()

Возвращаемое значение

IQueryable<IDocumentComparisonInfo> – Список результатов сравнений, инициированных текущим пользователем по текущему документу.

GetControlExecutionState

Получить статус контроля исполнения документа.

Синтаксис

[Public]

public virtual Enumeration? GetControlExecutionState()

Возвращаемое значение

Enumeration? – Статус контроля исполнения документа.

GetCounterpartyResponsible

Получить ответственного за контрагента.

Синтаксис

[ExpressionElement("CounterpartyResponsible",  "CounterpartyResponsibleDescription")]

public static IEmployee GetCounterpartyResponsible(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

IEmployee – Ответственный.

GetCreatedActionItems

Получение созданных поручений по документу.

Синтаксис

[Public, Remote]

public virtual IQueryable<RecordManagement.IActionItemExecutionTask> GetCreatedActionItems()

Возвращаемое значение

IQueryable<RecordManagement.IActionItemExecutionTask> – Созданные поручения по документу.

GetDateFromText

Получить дату из текста.

Синтаксис

public virtual DateTime? GetDateFromText(string dateTimeText)

Параметры

dateTimeText – Текст.

Возвращаемое значение

DateTime? – Дата.

GetDefaultApprovalRule

Получить правила согласования по умолчанию для документа.

Если подходящих правил нет или их несколько, то вернется null.

Синтаксис

[Remote, Public]

public virtual IApprovalRuleBase GetDefaultApprovalRule()

Возвращаемое значение

IApprovalRuleBase – Правила согласования по умолчанию.

GetDefaultDocumentKind

Получить вид документа по умолчанию.

Синтаксис

[Public]

public virtual IDocumentKind GetDefaultDocumentKind()

Возвращаемое значение

IDocumentKind – Вид документа.

GetDefaultSignatory

Получить подписывающего по умолчанию.

Синтаксис

public virtual Sungero.Company.IEmployee GetDefaultSignatory()

Возвращаемое значение

Sungero.Company.IEmployee – Подписывающий по умолчанию.

GetDefaultSignatureSetting

Получить право подписи сотрудника по умолчанию.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual ISignatureSetting GetDefaultSignatureSetting(IEmployee signatory)

Параметры

signatory – Сотрудник.

Возвращаемое значение

ISignatureSetting – Право подписи сотрудника по умолчанию.

GetDocumentActionItemTableTags

Получить список названий столбцов таблицы.

Синтаксис

public virtual List<string> GetDocumentActionItemTableTags()

Возвращаемое значение

List<string> – Список названий столбцов таблицы.

GetDocumentKinds

Получить виды документов для фильтрации подходящих прав подписи.

Синтаксис

public virtual List<IDocumentKind> GetDocumentKinds()

Возвращаемое значение

List<IDocumentKind> – Виды документов.

GetDocumentLockErrors

Возвращает ошибки заблокированности документа.

Синтаксис

[Public]

public virtual List<string> GetDocumentLockErrors()

Возвращаемое значение

List<string> – Ошибки заблокированности документа.

GetDocumentRegistrar

Получить регистратора документа.

Синтаксис

[ExpressionElement("DocumentRegistrar",  "DocumentRegistrarDescription")]

public static IEmployee GetDocumentRegistrar(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

IEmployee – Регистратор.

GetDocumentResponsible

Получить ответственного за документ.

Синтаксис

[ExpressionElement("DocumentResponsible",  "DocumentResponsibleDescription")]

public static IEmployee GetDocumentResponsible(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

IEmployee – Ответственный.

GetDocumentReviewTasks

Получить задачи на рассмотрение по текущему документу.

Синтаксис

[Public]

public List<RecordManagement.IDocumentReviewTask> GetDocumentReviewTasks()

Возвращаемое значение

List<RecordManagement.IDocumentReviewTask> – Задачи на рассмотрение по текущему документу.

GetDocumentSummary

Построить сводку по документу.

Синтаксис

[Remote(IsPure = true)],  [LocalizeFunction("GetDocumentSummaryFunctionName",  "GetDocumentSummaryFunctionDescription")]

public virtual StateView GetDocumentSummary()

Возвращаемое значение

StateView – Сводка по документу.

GetEmployeesFromText

Получить список сотрудников из текста.

Синтаксис

public virtual List<IEmployee> GetEmployeesFromText(string employeesText)

Параметры

employeesText – Текст.

Возвращаемое значение

List<IEmployee> – Список сотрудников.

GetExchangeLocation

Получить местонахождение документа в сервисе обмена.

Синтаксис

public string GetExchangeLocation()

Возвращаемое значение

string – Местонахождение документа в сервисе обмена. Пусто - если документ не ходил через сервис обмена.

GetExchangeServices

Получить сервисы обмена.

Переопределено в OutgoingDocumentBase.

Синтаксис

[Public]

public virtual List<ExchangeCore.IExchangeService> GetExchangeServices()

Возвращаемое значение

List<ExchangeCore.IExchangeService> – Сервисы обмена.

GetExchangeServicesByBusinessUnit

Получить сервисы обмена по нашей организации.

Если в документе не указана НОР, то используется НОР от текущего сотрудника.

Синтаксис

public virtual List<ExchangeCore.IExchangeService> GetExchangeServicesByBusinessUnit()

Возвращаемое значение

List<ExchangeCore.IExchangeService> – Сервисы обмена.

GetExchangeServicesByCounterparties

Получить сервисы обмена по контрагентам.

Синтаксис

public virtual List<ExchangeCore.IExchangeService> GetExchangeServicesByCounterparties()

Возвращаемое значение

List<ExchangeCore.IExchangeService> – Сервисы обмена.

GetExchangeServicesByExchangeDocumentInfo

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

Синтаксис

public virtual List<ExchangeCore.IExchangeService> GetExchangeServicesByExchangeDocumentInfo()

Возвращаемое значение

List<ExchangeCore.IExchangeService> – Сервисы обмена.

GetExtensionValidationErrorRemote

Получить сообщение об ошибке для неподдерживаемых форматов.

Синтаксис

[Remote]

public Structures.OfficialDocument.IConversionToPdfResult GetExtensionValidationErrorRemote(string extension)

Параметры

extension – Расширение.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат преобразования.

GetFirstLevelActionItems

Получить поручения первого уровня по документу.

Самостоятельные поручения по документу и поручения,

которые созданы от заданий и задач других типов (согласование или рассмотрение).

Синтаксис

[Public]

public virtual List<RecordManagement.IActionItemExecutionTask> GetFirstLevelActionItems()

Возвращаемое значение

List<RecordManagement.IActionItemExecutionTask> – Поручения первого уровня по документу.

GetFormalizedPoA

Получить электронную доверенность.

Синтаксис

[Public]

public virtual IFormalizedPowerOfAttorney GetFormalizedPoA(IEmployee employee, ICertificate certificate)

Параметры

employee – Сотрудник;

certificate – Сертификат.

Возвращаемое значение

IFormalizedPowerOfAttorney – Электронная доверенность.

GetFormalizedPoAUnifiedRegNo

Синтаксис

[Public, Remote]

public virtual string GetFormalizedPoAUnifiedRegNo(IEmployee employee, ICertificate certificate)

Параметры

employee

certificate

GetHistoryCommentParamName

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

Синтаксис

public virtual string GetHistoryCommentParamName()

Возвращаемое значение

string – Имя параметра.

GetHistoryOperationByLifeCycleState

Получить операцию по статусу.

Синтаксис

[Obsolete("Метод не используется с 30.08.2023 и версии 4.8. Используйте метод GetHistoryOperationTextByLifeCycleState.")]

public static Enumeration? GetHistoryOperationByLifeCycleState(Enumeration? state, string statePrefix, bool isUpdateAction)

Параметры

state – Статус;

statePrefix – Префикс;

isUpdateAction – Признак обновления.

Возвращаемое значение

Enumeration? – Операция по статусу.

GetHistoryOperationTextByLifeCycleState

Получить операцию по статусу.

Синтаксис

public static string GetHistoryOperationTextByLifeCycleState(Enumeration? state, string statePrefix, bool isUpdateAction)

Параметры

state – Статус;

statePrefix – Префикс;

isUpdateAction – Признак обновления.

Возвращаемое значение

string – Операция по статусу.

GetIndexFromRegistrationNumber

Синтаксис

public virtual void GetIndexFromRegistrationNumber()

GetLatestDocumentTracking

Получить самую позднюю строку выдачи с действием "Отправка контрагенту" или "Согласование с контрагентом" и незаполненной датой возврата.

Если есть подходящая строка выдачи с действием "Согласование с контрагентом", то в результате вернется она.

Синтаксис

[Public]

public virtual IOfficialDocumentTracking GetLatestDocumentTracking()

Возвращаемое значение

IOfficialDocumentTracking – Строка выдачи с незаполненной датой возврата и наибольшей датой выдачи.

GetLocationState

Сформировать текстовку для местонахождения.

Синтаксис

public virtual string GetLocationState()

Возвращаемое значение

string – Местонахождение.

GetNoteWithCounterpartySigningReason

Получить текст примечания с основанием подписания контрагента.

Синтаксис

[Public]

public virtual string GetNoteWithCounterpartySigningReason()

Возвращаемое значение

string – Текст примечания.

GetOfficialDocument

Получить документ по ИД.

Синтаксис

[Remote(IsPure = true), Public]

public static Docflow.IOfficialDocument GetOfficialDocument(long id)

Параметры

id – ИД документа.

Возвращаемое значение

Docflow.IOfficialDocument – Документ.

GetOfficialDocumentParams

Получить параметры для кеширования.

Синтаксис

[Remote(IsPure = true)]

public virtual Structures.OfficialDocument.IOfficialDocumentParams GetOfficialDocumentParams()

Возвращаемое значение

Structures.OfficialDocument.IOfficialDocumentParams – Структура с параметрами документа.

GetOrCreateAnchorBasedMark

Получить отметку документа для простановки по якорю.

Если отметки не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateAnchorBasedMark(string markKindSid, string anchor)

Параметры

markKindSid – Sid вида отметки;

anchor – Якорь.

Возвращаемое значение

IMark – Отметка документа для простановки по якорю.

GetOrCreateAnchorBasedSignatureMark

Получить отметку об электронной подписи документа для простановки по якорю.

Если отметки об электронной подписи не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateAnchorBasedSignatureMark()

Возвращаемое значение

IMark – Отметка об электронной подписи документа для простановки по якорю.

GetOrCreateLeftTopCoordinateBasedMark

Получить отметку документа для простановки по координатам от левого верхнего угла документа.

Если отметки не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateLeftTopCoordinateBasedMark(string markKindSid, int page, double leftIndent, double topIndent)

Параметры

markKindSid – Sid вида отметки;

page – Страница;

leftIndent – Отступ слева, см;

topIndent – Отступ сверху, см.

Возвращаемое значение

IMark – Отметка документа для простановки по координатам от левого верхнего угла документа.

GetOrCreateLeftTopCoordinateBasedRegistrationDateMark

Получить отметку о дате регистрации документа для простановки по координатам от левого верхнего угла документа.

Если отметки о дате регистрации не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateLeftTopCoordinateBasedRegistrationDateMark(int page, double leftIndent, double topIndent)

Параметры

page – Страница;

leftIndent – Отступ слева, см;

topIndent – Отступ сверху, см.

Возвращаемое значение

IMark – Отметка о дате регистрации документа для простановки по координатам от левого верхнего угла документа.

GetOrCreateLeftTopCoordinateBasedRegistrationNumberMark

Получить отметку о номере регистрации документа для простановки по координатам от левого верхнего угла документа.

Если отметки о номере регистрации не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateLeftTopCoordinateBasedRegistrationNumberMark(int page, double leftIndent, double topIndent)

Параметры

page – Страница;

leftIndent – Отступ слева, см;

topIndent – Отступ сверху, см.

Возвращаемое значение

IMark – Отметка о номере регистрации документа для простановки по координатам от левого верхнего угла документа.

GetOrCreateMark

Получить отметку документа определённого вида.

Перегрузки

 

GetOrCreateMark (IMarkKind markKind)

Получить отметку документа определённого вида.

Если отметки указанного вида не существует, то она будет создана.

Синтаксис

public virtual IMark GetOrCreateMark(IMarkKind markKind)

Параметры

markKind – Вид отметки.

Возвращаемое значение

IMark – Отметка указанного вида.

GetOrCreateMark (string markKindSid)

Получить отметку документа определённого вида.

Если отметки указанного вида не существует, то она будет создана.

Синтаксис

public virtual IMark GetOrCreateMark(string markKindSid)

Параметры

markKindSid – Sid вида отметки.

Возвращаемое значение

IMark – Отметка указанного вида.

GetOrCreateRegistrationDateMark

Получить экземпляр отметки о дате регистрации документа.

Если отметки о дате регистрации документа не существует, то будет создана отметка для простановки по тэгам.

Синтаксис

[Remote, Public]

public virtual IMark GetOrCreateRegistrationDateMark()

Возвращаемое значение

IMark – Отметка о дате регистрации документа.

GetOrCreateRegistrationNumberMark

Получить отметку о номере регистрации документа.

Если отметки о номере регистрации документа не существует, то будет создана отметка для простановки по тэгам.

Синтаксис

[Remote, Public]

public virtual IMark GetOrCreateRegistrationNumberMark()

Возвращаемое значение

IMark – Отметка о номере регистрации документа.

GetOrCreateSignatureMark

Получить экземпляр отметки об электронной подписи документа.

Если отметки об электронной подписи документа не существует, то будет создана отметка для простановки по якорю.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateSignatureMark()

Возвращаемое значение

IMark – Отметка об электронной подписи документа.

GetOrCreateTagBasedMark

Получить отметку документа для простановки по тэгам.

Если отметки не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateTagBasedMark(string markKindSid, List<string> tags)

Параметры

markKindSid – Sid вида отметки;

tags – Тэги.

Возвращаемое значение

IMark – Отметка документа для простановки по тэгам.

GetOrCreateTagBasedRegistrationDateMark

Получить отметку о дате регистрации документа для простановки по тэгам.

Если отметки о дате регистрации не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateTagBasedRegistrationDateMark()

Возвращаемое значение

IMark – Отметка о дате регистрации документа для простановки по тэгам.

GetOrCreateTagBasedRegistrationNumberMark

Получить отметку о номере регистрации документа для простановки по тэгам.

Если отметки о номере регистрации не существует, то она будет создана.

Синтаксис

[Public, Remote]

public virtual IMark GetOrCreateTagBasedRegistrationNumberMark()

Возвращаемое значение

IMark – Отметка о номере регистрации документа для простановки по тэгам.

GetOutgoingDocumentsRegistrar

Получить регистратора исходящей корреспонденции.

Синтаксис

[ExpressionElement("OutgoingDocumentsRegistrar",  "OutgoingDocumentsRegistrarDescription")]

public static IEmployee GetOutgoingDocumentsRegistrar(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

IEmployee – Регистратор.

GetPerformersInText

Сформировать текстовый список исполнителей заданий.

Синтаксис

[Public]

public static string GetPerformersInText(List<IEmployee> employees)

Параметры

employees – Сотрудники.

Возвращаемое значение

string – Строка в формате "Ардо Н.А., Соболева Н.Н. и еще 2 сотрудника.".

GetPropertyValue

Получить значение свойства.

Синтаксис

public virtual string GetPropertyValue(string propertyName)

Параметры

propertyName – Имя свойства.

Возвращаемое значение

string – Значение свойства в виде строки.

GetRegistrationDateMarkContent

Получить дату регистрации документа в виде строки.

Используется в методе GetContent вида отметки "Дата регистрации". ИД версии - потенциальная точка расширения для перекрытий.

Синтаксис

public virtual string GetRegistrationDateMarkContent(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

string – Дата регистрации документа в виде строки.

GetRegistrationDialogParams

Получить все данные для отображения диалога регистрации.

Синтаксис

[Remote(IsPure = true)]

public static Structures.OfficialDocument.IDialogParamsLite GetRegistrationDialogParams(IOfficialDocument document, Enumeration operation)

Параметры

document – Документ;

operation – Операция.

Возвращаемое значение

Structures.OfficialDocument.IDialogParamsLite – Параметры диалога.

GetRegistrationNumberMarkContent

Получить содержание отметки о регистрационном номере документа для проставления по тегам.

Используется в методе GetContent вида отметки "Регистрационный номер". ИД версии - потенциальная точка расширения для перекрытий.

Синтаксис

public virtual string GetRegistrationNumberMarkContent(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

string – Содержание отметки о регистрационном номере документа.

GetRegistrationStampAsHtml

Получить отметку о регистрации.

Перегрузки

 

GetRegistrationStampAsHtml ()

Получить отметку о регистрации.

Синтаксис

[Public,  Obsolete("Метод не используется с 15.07.2024 и версии 4.11. Используйте метод GetRegistrationStampAsHtml(long versionId).")]

public virtual string GetRegistrationStampAsHtml()

Возвращаемое значение

string – Изображение отметки о регистрации в виде html.

GetRegistrationStampAsHtml (long versionId)

Получить отметку о регистрации.

Параметр versionId добавлен для совместимости с другими методами получения отметок и является потенциальной точкой расширения.

Синтаксис

[Public]

public virtual string GetRegistrationStampAsHtml(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

string – Изображение отметки о регистрации в виде html.

GetRegNumberValidationResult

Синтаксис

public virtual Structures.OfficialDocument.RegNumberValidationResult GetRegNumberValidationResult(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

GetRelatedDocumentsByRelationType

Получить связанные документы по типу связи.

Синтаксис

[Remote]

public static List<IOfficialDocument> GetRelatedDocumentsByRelationType(IOfficialDocument document, string relationTypeName, bool withVersion)

Параметры

document – Документ, для которого получаются связанные документы;

relationTypeName – Наименование типа связи;

withVersion – Учитывать только документы с версиями.

Возвращаемое значение

List<IOfficialDocument> – Связанные документы.

GetRelationTypeByName

Получить тип связи по наименованию.

Синтаксис

[Remote]

public static Sungero.CoreEntities.IRelationType GetRelationTypeByName(string relationName)

Параметры

relationName – Наименование типа связи.

Возвращаемое значение

Sungero.CoreEntities.IRelationType – Тип связи.

GetReturnAssignments

Получить задания на возврат по документу.

Перегрузки

 

GetReturnAssignments (List<Sungero.Workflow.ITask> returnTasks)

Получить задания на возврат по документу.

Синтаксис

[Remote(IsPure = true)]

public static List<Sungero.Workflow.IAssignment> GetReturnAssignments(List<Sungero.Workflow.ITask> returnTasks)

Параметры

returnTasks – Задачи.

Возвращаемое значение

List<Sungero.Workflow.IAssignment> – Задания на возврат.

GetReturnAssignments (Sungero.Workflow.ITask returnTask)

Получить задания на возврат по документу.

Синтаксис

[Remote(IsPure = true)]

public static List<Sungero.Workflow.IAssignment> GetReturnAssignments(Sungero.Workflow.ITask returnTask)

Параметры

returnTask – Задача.

Возвращаемое значение

List<Sungero.Workflow.IAssignment> – Задания на возврат.

GetSignatoriesIds

Возвращает список ИД подписывающих по критериям.

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

Синтаксис

[Remote(IsPure = true)]

public virtual List<long> GetSignatoriesIds()

Возвращаемое значение

List<long> – Список тех, кто имеет право подписи.

GetSignatoriesIdsForCancellationAgreement

Получить подписантов, которые могут подписывать соглашение об аннулировании.

Синтаксис

[Remote(IsPure = true)]

public virtual List<long> GetSignatoriesIdsForCancellationAgreement()

Возвращаемое значение

List<long> – ИД подписантов.

GetSignatureForMark

Получить электронную подпись для простановки отметки.

Перегрузки

 

GetSignatureForMark (long versionId)

Получить электронную подпись для простановки отметки.

Синтаксис

[Public]

public virtual Sungero.Domain.Shared.ISignature GetSignatureForMark(long versionId)

Параметры

versionId – Номер версии.

Возвращаемое значение

Sungero.Domain.Shared.ISignature – Электронная подпись.

GetSignatureForMark (long versionId, bool includeExternalSignature)

Получить электронную подпись для простановки отметки.

Синтаксис

[Public]

public virtual Sungero.Domain.Shared.ISignature GetSignatureForMark(long versionId, bool includeExternalSignature)

Параметры

versionId – Номер версии;

includeExternalSignature – Признак того, что в выборку включены внешние подписи.

Возвращаемое значение

Sungero.Domain.Shared.ISignature – Электронная подпись.

GetSignatureFromOurSignatory

Получить электронную подпись для регистрации в ФНС.

Синтаксис

[Public]

public virtual Sungero.Domain.Shared.ISignature GetSignatureFromOurSignatory(long versionId)

Параметры

versionId – Номер версии.

Возвращаемое значение

Sungero.Domain.Shared.ISignature – Электронная подпись.

GetSignatureMarkAsHtml

Получить отметку об ЭП.

Синтаксис

[Public]

public virtual string GetSignatureMarkAsHtml(long versionId)

Параметры

versionId – ИД версии для генерации.

Возвращаемое значение

string – Изображение отметки об ЭП в виде html.

GetSignatureSettings

Получить права подписания документов.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual List<ISignatureSetting> GetSignatureSettings(IEmployee employee)

Параметры

employee – Сотрудник, для которого запрашиваются права.

Возвращаемое значение

List<ISignatureSetting> – Список подходящих правил.

GetSignatureSettingsByEmployee

Получить права подписи у сотрудника.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual IQueryable<ISignatureSetting> GetSignatureSettingsByEmployee(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

IQueryable<ISignatureSetting> – Список прав подписи.

GetSignatureSettingsForCancellationAgreement

Получить права подписи для соглашения об аннулировании по основному документу.

Синтаксис

[Public]

public virtual IQueryable<ISignatureSetting> GetSignatureSettingsForCancellationAgreement()

Возвращаемое значение

IQueryable<ISignatureSetting> – Права подписи на соглашение об аннулировании по основному документу.

GetSignatureSettingsQuery

Получить права подписания документов.

Перегрузки

 

GetSignatureSettingsQuery ()

Получить права подписания документов.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual IQueryable<ISignatureSetting> GetSignatureSettingsQuery()

Возвращаемое значение

IQueryable<ISignatureSetting> – Список подходящих правил.

GetSignatureSettingsQuery (List<IBusinessUnit> businessUnits, List<IDocumentKind> kinds, IDepartment department, Enumeration? docflow)

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

Синтаксис

public static IQueryable<ISignatureSetting> GetSignatureSettingsQuery(List<IBusinessUnit> businessUnits, List<IDocumentKind> kinds, IDepartment department, Enumeration? docflow)

Параметры

businessUnits – Список наших организаций;

kinds – Список видов документов;

department – Подразделение;

docflow – Документопоток.

Возвращаемое значение

IQueryable<ISignatureSetting> – Список подходящих правил.

GetSignatureSettingsWithCertificateByEmployee

Получить права подписи у сотрудника c действующим сертификатом.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual IQueryable<ISignatureSetting> GetSignatureSettingsWithCertificateByEmployee(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

IQueryable<ISignatureSetting> – Список прав подписи.

GetSigningOrganizationFromExchangeInfo

Получить сведения об организации, подписавшей документ, из сведений о документе обмена и подписи.

Синтаксис

public virtual Exchange.Structures.Module.IOrganizationInfo GetSigningOrganizationFromExchangeInfo(Sungero.Domain.Shared.ISignature signature)

Параметры

signature – Подпись.

Возвращаемое значение

Exchange.Structures.Module.IOrganizationInfo – Наименование и ИНН организации.

GetSmartProcessingSupportedProperties

Получить список свойств для сбора статистики распознавания.

Синтаксис

[Public]

public virtual List<Sungero.Domain.Shared.IPropertyInfo> GetSmartProcessingSupportedProperties()

Возвращаемое значение

List<Sungero.Domain.Shared.IPropertyInfo> – Список свойств.

GetStampSettings

Получить подходящие настройки отметки об ЭП для документа.

Синтаксис

[Public]

public virtual List<IStampSetting> GetStampSettings()

Возвращаемое значение

List<IStampSetting> – Список подходящих настроек.

GetStateView

Построить модель состояния документа.

По идее, одноименная функция ожидается у всех сущностей, которым нужно представление состояния.

Синтаксис

[Public]

public static Sungero.Core.StateView GetStateView(IElectronicDocument document)

Параметры

document – Документ.

Возвращаемое значение

Sungero.Core.StateView – Схема модели состояния.

GetStateViewXml

Построить модель состояния документа.

Синтаксис

[Remote(IsPure = true)],  [LocalizeFunction("GetStateViewXmlFunctionName",  "GetStateViewXmlFunctionDescription")]

public Sungero.Core.StateView GetStateViewXml()

Возвращаемое значение

Sungero.Core.StateView – Контрол состояния.

GetSuitableOurSigningReason

Получить подходящее право подписи.

Синтаксис

public virtual ISignatureSetting GetSuitableOurSigningReason(IEmployee employee, ICertificate certificate, bool changedSignatory)

Параметры

employee – Сотрудник;

certificate – Сертификат;

changedSignatory – Признак смены подписывающего.

Возвращаемое значение

ISignatureSetting – Право подписи.

GetTaskIdsWhereDocumentInRequredGroup

Получить ИД задач, в которых документ вложен в обязательные группы.

Синтаксис

[Remote]

public virtual List<long> GetTaskIdsWhereDocumentInRequredGroup()

Возвращаемое значение

List<long> – Список ИД задач.

GetTotalAmountDocumentSummary

Получить отображение суммы документа.

Синтаксис

public virtual string GetTotalAmountDocumentSummary(double? totalAmount)

Параметры

totalAmount – Значение суммы.

Возвращаемое значение

string – Отображение суммы документа.

GetUnreturnedFromCounterpartyTracking

Получить строки выдачи документа с незаполненной датой возврата (документ еще на согласовании у контрагента).

Перегрузки

 

GetUnreturnedFromCounterpartyTracking (ITask returnTask)

Получить строки выдачи документа с незаполненной датой возврата (документ еще на согласовании у контрагента).

Синтаксис

[Public]

public virtual List<Sungero.Docflow.IOfficialDocumentTracking> GetUnreturnedFromCounterpartyTracking(ITask returnTask)

Параметры

returnTask – Задача возврата.

Возвращаемое значение

List<Sungero.Docflow.IOfficialDocumentTracking> – Строки выдачи с незаполненной датой возврата.

GetUnreturnedFromCounterpartyTracking (long externalLinkId)

Получить строку выдачи документа с незаполненным результатом возврата (документ еще на согласовании у контрагента в сервисе обмена).

Синтаксис

[Public]

public virtual Sungero.Docflow.IOfficialDocumentTracking GetUnreturnedFromCounterpartyTracking(long externalLinkId)

Параметры

externalLinkId – ИД записи с информацией о документе в сервисе обмена.

Возвращаемое значение

Sungero.Docflow.IOfficialDocumentTracking – Строка выдачи с незаполненным результатом возврата.

GetUserActionText

Построить текст действия от пользователя.

Синтаксис

[Public]

public static string GetUserActionText(IUser user, string text, IUser substituted)

Параметры

user – Пользователь;

text – Текст;

substituted – Замещаемый.

Возвращаемое значение

string – Сформированная строка вида "Пользователь (за замещаемого). Текст действия.".

GetVersionBodyHash

Получить хеш тела версии документа.

Если документ зашифрован то берем хеш расшифрованного тела версии документа.

Синтаксис

[Public]

public virtual string GetVersionBodyHash(IElectronicDocumentVersions version)

Параметры

version – Версия документа.

Возвращаемое значение

string – Хеш тела версии документа.

GetVersionMarks

Получить сохранённые отметки для версии.

Перегрузки

 

GetVersionMarks (long versionId)

Получить сохранённые отметки для версии.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual List<IMark> GetVersionMarks(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

List<IMark> – Список отметок.

GetVersionMarks (long versionId, IMarkKind markKind)

Получить отметки для версии документа.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual List<IMark> GetVersionMarks(long versionId, IMarkKind markKind)

Параметры

versionId – ИД версии документа;

markKind – Вид отметки.

Возвращаемое значение

List<IMark> – Отметки указанного вида для версии документа.

GetVersionMarks (long versionId, string markKindSid)

Получить отметки для версии документа.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual List<IMark> GetVersionMarks(long versionId, string markKindSid)

Параметры

versionId – ИД версии документа;

markKindSid – Sid вида отметки.

Возвращаемое значение

List<IMark> – Отметки указанного вида для версии документа.

GrantAccessRightsToActionItemAttachment

Выдать сотруднику права на документ.

Синтаксис

[Public]

public virtual void GrantAccessRightsToActionItemAttachment(IEmployee employee)

Параметры

employee – Сотрудник.

GrantRegistrationGroupRights

Перегрузки

 

GrantRegistrationGroupRights ()

Синтаксис

public virtual void GrantRegistrationGroupRights()

GrantRegistrationGroupRights (Sungero.Domain.BeforeSaveEventArgs e)

Синтаксис

public virtual void GrantRegistrationGroupRights(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

HasAcquaintanceTasks

Определить, есть ли задачи на ознакомление документа.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool HasAcquaintanceTasks(int? versionNumber, bool includeCompleted, bool includeAborted)

Параметры

versionNumber – Номер версии;

includeCompleted – Учитывать выполненные задачи;

includeAborted – Учитывать прекращенные задачи.

Возвращаемое значение

bool – True, если есть.

HasActionItemExecutionTasks

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

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool HasActionItemExecutionTasks()

Возвращаемое значение

bool – True, если по документу уже созданы поручения.

HasActiveActionItemExecutionTasks

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

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool HasActiveActionItemExecutionTasks()

Возвращаемое значение

bool – True, если по документу есть поручения в работе.

HasActiveOrCompletedActionItems

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

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool HasActiveOrCompletedActionItems()

Возвращаемое значение

bool – True, если по документу есть активные или исполненные поручения.

HasApprovalTasksWithCurrentDocument

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

Синтаксис

[Public, Remote]

public bool HasApprovalTasksWithCurrentDocument()

Возвращаемое значение

bool – True, если есть.

HasNewApprovalTasks

Есть ли новые задачи в работе после прекращения задачи на согласование документа по регламенту/процессу.

Синтаксис

[Public]

public virtual bool HasNewApprovalTasks(DateTime? abortedDate)

Параметры

abortedDate – Дата и время прекращения задачи.

Возвращаемое значение

bool – True - есть задачи в работе, False - нет.

HasSignatureForApprovalSheetReport

Проверить наличие согласующих или утверждающих подписей на документе.

Синтаксис

[Remote(IsPure = true)]

public bool HasSignatureForApprovalSheetReport()

Возвращаемое значение

bool – True, если есть хоть одна подпись для отображения в отчете.

HasSpecifiedTypeRelations

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

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool HasSpecifiedTypeRelations()

Возвращаемое значение

bool – True - если связан, иначе - false.

InitialsAndLastName

Получить инициалы и фамилию контакта для шаблона документа.

Перегрузки

 

InitialsAndLastName (IContact contact)

Получить инициалы и фамилию контакта для шаблона документа.

Синтаксис

[Sungero.Core.Converter("InitialsAndLastName")]

public static PersonFullName InitialsAndLastName(IContact contact)

Параметры

contact – Контакт.

Возвращаемое значение

PersonFullName – Инициалы и фамилия контакта.

InitialsAndLastName (IEmployee employee)

Получить инициалы и фамилию сотрудника для шаблона документа.

Синтаксис

[Sungero.Core.Converter("InitialsAndLastName")]

public static PersonFullName InitialsAndLastName(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

PersonFullName – Инициалы и фамилия сотрудника.

InitialsAndLastName (IPerson person)

Получить инициалы и фамилию персоны для шаблона документа.

Синтаксис

[Sungero.Core.Converter("InitialsAndLastName")]

public static PersonFullName InitialsAndLastName(IPerson person)

Параметры

person – Персона.

Возвращаемое значение

PersonFullName – Инициалы и фамилия персоны.

IsAutoNumbering

Синтаксис

public virtual bool IsAutoNumbering(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

IsExchangeDocument

Признак, является ли документ МКДО.

Синтаксис

[Public,  Remote(IsPure = true)]

public virtual bool IsExchangeDocument(long versionId)

Параметры

versionId – ИД версии.

Возвращаемое значение

bool – True - если документ участвовал в сервисе обмена, либо формализованный, либо является соглашением об аннулировании.

IsNumberValidationDisabled

Признак того, что формат номера не надо валидировать.

Синтаксис

[Remote(IsPure = true)]

public virtual bool IsNumberValidationDisabled()

Возвращаемое значение

bool – True, если формат номера неважен.

IsOnlyVersionChanged

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

Синтаксис

public bool IsOnlyVersionChanged()

Возвращаемое значение

bool – Признак измененности.

IsOnVerification

Синтаксис

public virtual bool IsOnVerification()

IssueDocumentToCounterparty

Выдать документ сотруднику для отправки контрагенту.

Синтаксис

[Public]

public virtual void IssueDocumentToCounterparty(long responsibleForReturnId, Enumeration action, DateTime? returnDeadline, ITask returnTask)

Параметры

responsibleForReturnId – ИД ответственного за возврат документа;

action – Действие;

returnDeadline – Срок возврата;

returnTask – Задача возврата.

IsSupportedLifeCycleState

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

Синтаксис

[Public]

public static bool IsSupportedLifeCycleState(IElectronicDocument document)

Параметры

document – Документ.

Возвращаемое значение

bool – True, если состояние совпадает с любым доступным состоянием официального документа.False, если документ не является официальным или его состояние отличается от доступных для официального документа.

KindCode

Синтаксис

public virtual string KindCode()

LastNameAndInitials

Получить фамилию и инициалы контакта для шаблона документа.

Перегрузки

 

LastNameAndInitials (IContact contact)

Получить фамилию и инициалы контакта для шаблона документа.

Синтаксис

[Sungero.Core.Converter("LastNameAndInitials")]

public static PersonFullName LastNameAndInitials(IContact contact)

Параметры

contact – Контакт.

Возвращаемое значение

PersonFullName – Фамилия и инициалы контакта.

LastNameAndInitials (IEmployee employee)

Получить фамилию и инициалы сотрудника для шаблона документа.

Синтаксис

[Sungero.Core.Converter("LastNameAndInitials")]

public static PersonFullName LastNameAndInitials(IEmployee employee)

Параметры

employee – Сотрудник.

Возвращаемое значение

PersonFullName – Фамилия и инициалы сотрудника.

LastNameAndInitials (IPerson counterparty)

Получить фамилию и инициалы персоны для шаблона документа.

Синтаксис

[Sungero.Core.Converter("LastNameAndInitials")]

public static PersonFullName LastNameAndInitials(IPerson counterparty)

Параметры

counterparty – Персона.

Возвращаемое значение

PersonFullName – Фамилия и инициалы персоны.

LeadDocNumber

Синтаксис

public virtual string LeadDocNumber()

LockRegistrationFields

Синтаксис

public virtual void LockRegistrationFields()

ModifiedChanged

Синтаксис

public virtual bool ModifiedChanged()

NeedValidateOurSignatorySignatureSetting

Признак того, что необходимо проверять наличие прав подписи на документ у сотрудника, указанного в качестве подписанта с нашей стороны.

Поведение по умолчанию - проверять.

Может быть переопределена в наследниках.

Синтаксис

public virtual bool NeedValidateOurSignatorySignatureSetting()

Возвращаемое значение

bool – True - необходимо проверять, False - иначе.

OurSigningReasonIsValid

Проверить возможность подписания с выбранным основанием.

Синтаксис

[Public]

public virtual bool OurSigningReasonIsValid(ISignatureSetting ourSigningReason, ICertificate certificate, List<ISignatureSetting> settings)

Параметры

ourSigningReason – Основание документа;

certificate – Сертификат для подписания;

settings – Список прав подписи.

Возвращаемое значение

bool – Признак того, подходит ли основания для подписания документа.

PerformerNotes

Получить отметку об исполнителе для шаблона документа.

Синтаксис

[Sungero.Core.Converter("PerformerNotes")]

public static string PerformerNotes(IOfficialDocument document)

Параметры

document – Документ.

Возвращаемое значение

string – Отметка об исполнителе.

PreparePreview

Отправить запрос на подготовку предпросмотра документа.

Синтаксис

[Public]

public virtual void PreparePreview()

RegisterAndNumerate

Синтаксис

public virtual void RegisterAndNumerate(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

RelateDocumentsToPrimaryDocumentAsAddenda

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

Синтаксис

[Public,  Obsolete("Метод не используется с 04.04.2024 и версии 4.10. Используйте метод RelateDocumentsToPrimaryDocumentAsAddenda модуля DocflowApproval.")]

public virtual void RelateDocumentsToPrimaryDocumentAsAddenda(List<IOfficialDocument> documents)

Параметры

documents – Список документов.

ReturningTasksControl

Синтаксис

public virtual void ReturningTasksControl(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

SaveConvertedBody

Сохранить тело документа после преобразования в PDF с отметками.

Синтаксис

public virtual void SaveConvertedBody(Structures.Module.IDocumentMarksDto documentWithMarks)

Параметры

documentWithMarks – Структура с преобразованным телом документа.

SendAnswer

Отправить ответ на неформализованный документ.

Синтаксис

[Public]

public virtual void SendAnswer(Sungero.ExchangeCore.IBusinessUnitBox box, Parties.ICounterparty party, ICertificate certificate, bool isAgent)

Параметры

box – Абонентский ящик обмена;

party – Контрагент;

certificate – Сертификат;

isAgent – Признак вызова из фонового процесса. Иначе - пользователем в RX.

SendDocuments

Отправить документ в сервис обмена.

Синтаксис

[Remote, Public]

public virtual void SendDocuments(List<Sungero.Docflow.IOfficialDocument> addenda, Parties.ICounterparty receiver, string receiverServiceDepartmentId, ExchangeCore.IBusinessUnitBox senderBox, string senderServiceDepartmentId, ICertificate certificate, bool needSign, string comment)

Параметры

addenda – Приложения;

receiver – Получатель (головная организация или филиал контрагента);

receiverServiceDepartmentId – Внешний ИД подразделения контрагента;

senderBox – Абонентский ящик отправителя;

senderServiceDepartmentId – Внешний ИД подразделения абонентского ящика отправителя;

certificate – Сертификат, которым подписаны документы;

needSign – Требовать подписание от контрагента;

comment – Комментарий к сообщению в сервисе.

SetControlExecutionState

Установить статус контроля исполнения документа.

Синтаксис

[Public]

public virtual void SetControlExecutionState(Enumeration? state)

Параметры

state – Статус.

SetDeliveryMethod

Установить способ доставки.

Синтаксис

[Public]

public virtual void SetDeliveryMethod(IMailDeliveryMethod deliveryMethod)

Параметры

deliveryMethod – Способ доставки.

SetDocumentAssignee

Заполнить исполнителя по документу.

Синтаксис

[Public]

public virtual void SetDocumentAssignee(IEmployee assignee)

Параметры

assignee – Исполнитель.

SetDocumentSignatory

Заполнить подписывающего в карточке документа.

Синтаксис

[Public, Remote]

public virtual void SetDocumentSignatory(IEmployee employee)

Параметры

employee – Сотрудник.

SetElectronicMediumType

Указать, что вид носителя документа - электронный.

Синтаксис

[Public]

public virtual void SetElectronicMediumType()

SetExecutionState

Установить статус исполнения документа.

Синтаксис

[Public]

public virtual void SetExecutionState(Enumeration? state)

Параметры

state – Статус.

SetInternalApprovalStateToSigned

Заполнить статус согласования "Подписан".

Синтаксис

[Remote]

public void SetInternalApprovalStateToSigned()

SetLifeCycleStateDraft

Изменить статус документа на "В разработке".

Синтаксис

[Public]

public virtual void SetLifeCycleStateDraft()

SetOurSigningReason

Заполнить основание в карточке документа.

Синтаксис

public virtual void SetOurSigningReason(IEmployee employee, Sungero.Domain.BeforeSigningEventArgs e, bool changedSignatory)

Параметры

employee – Сотрудник;

e – Аргументы события подписания;

changedSignatory – Признак смены подписывающего.

SetUnifiedRegistrationNumber

Заполнить Единый рег. № из эл. доверенности в подпись.

Перегрузки

 

SetUnifiedRegistrationNumber (Company.IEmployee employee, Sungero.Domain.Shared.ISignature signature, ICertificate certificate)

Заполнить Единый рег. № из эл. доверенности в подпись.

Синтаксис

public virtual void SetUnifiedRegistrationNumber(Company.IEmployee employee, Sungero.Domain.Shared.ISignature signature, ICertificate certificate)

Параметры

employee – Сотрудник;

signature – Подпись;

certificate – Сертификат для подписания.

SetUnifiedRegistrationNumber (ISignatureSetting ourSigningReason, Sungero.Domain.Shared.ISignature signature, ICertificate certificate)

Заполнить Единый рег. № из эл. доверенности в подпись.

Синтаксис

public virtual void SetUnifiedRegistrationNumber(ISignatureSetting ourSigningReason, Sungero.Domain.Shared.ISignature signature, ICertificate certificate)

Параметры

ourSigningReason – Основание;

signature – Подпись;

certificate – Сертификат для подписания.

SignatorySettingWithAllUsersExist

Проверить наличие права подписи со всеми сотрудниками.

Синтаксис

[Remote(IsPure = true)]

public virtual bool SignatorySettingWithAllUsersExist()

Возвращаемое значение

bool – True - если есть право подписи со всеми сотрудниками.

StartActionItemTasksFromDialog

Старт задач на исполнение поручений по протоколу совещаний.

Синтаксис

[Public]

public virtual void StartActionItemTasksFromDialog(List<RecordManagement.IActionItemExecutionTask> actionItems)

Параметры

actionItems – Список задач для старта.

StatusChangeHistoryOperations

Синтаксис

public virtual System.Collections.Generic.IEnumerable<Sungero.Docflow.Structures.OfficialDocument.HistoryOperation> StatusChangeHistoryOperations(Sungero.Content.DocumentHistoryEventArgs e)

Параметры

e

StopTasksByDeletedTracking

Синтаксис

public virtual void StopTasksByDeletedTracking(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

StoreVerifiedPropertiesValues

Сохранить результат верификации заполнения свойств.

Синтаксис

[Public]

public virtual void StoreVerifiedPropertiesValues()

SyncReturnTaskDeadlines

Синтаксис

public virtual void SyncReturnTaskDeadlines(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

SyncStorage

Синтаксис

public virtual void SyncStorage()

TryDeleteActionItemTask

Удаление поручения, созданного по документу.

Синтаксис

[Remote]

public static bool TryDeleteActionItemTask(long actionItemId)

Параметры

actionItemId – ИД задачи, которую необходимо удалить.

Возвращаемое значение

bool – True, если удаление прошло успешно.

TryExternalRegister

Попытаться зарегистрировать документ с настройками по умолчанию.

Синтаксис

[Public]

public virtual bool TryExternalRegister(string number, DateTime? date)

Параметры

number – Номер;

date – Дата.

Возвращаемое значение

bool – True, если регистрация была выполнена.

UpdateExternalApprovalStateAfterReturnFromCounterparty

Обновить статус согласования с контрагентом после возврата документа.

Синтаксис

public virtual void UpdateExternalApprovalStateAfterReturnFromCounterparty()

UpdateOffDocFieldsBeforeSave

Синтаксис

public virtual void UpdateOffDocFieldsBeforeSave(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

UpdateTrackingAfterReturnFromCounterparty

Обновить выдачу в документе после возврата контрагентом.

Синтаксис

[Public]

public virtual void UpdateTrackingAfterReturnFromCounterparty(IRecipient responsibleForReturn, ITask returnTask, bool isSigned)

Параметры

responsibleForReturn – Ответственный за возврат документа;

returnTask – Задача возврата;

isSigned – Признак того, подписал ли контрагент документ.

ValidateBeforeRegistration

Синтаксис

public virtual void ValidateBeforeRegistration(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateBodyAndSignature

Проверить тело документа и наличие утверждающей подписи.

Синтаксис

[Public]

public virtual string ValidateBodyAndSignature()

Возвращаемое значение

string – Сообщение об ошибке или пустая строка, если ошибок нет.

ValidateCaseFileDataIsUnchanged

Синтаксис

public virtual void ValidateCaseFileDataIsUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateChangingDocumentKind

Синтаксис

public virtual void ValidateChangingDocumentKind(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateDocumentBeforeConversion

Проверить документ до преобразования в PDF.

Синтаксис

[Public, Remote]

public virtual Structures.OfficialDocument.IConversionToPdfResult ValidateDocumentBeforeConversion(long versionId)

Параметры

versionId – Id версии документа.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат проверки перед преобразованием документа.

ValidateDocumentBeforeConvertion

Проверить документ до преобразования в PDF.

Синтаксис

[Public, Remote,  Obsolete("Метод не используется с 28.08.2024 и версии 4.11. Используйте метод ValidateDocumentBeforeConversion.")]

public virtual Structures.OfficialDocument.IConversionToPdfResult ValidateDocumentBeforeConvertion(long versionId)

Параметры

versionId – Id версии документа.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат проверки перед преобразованием документа.

ValidateDocumentRegisterForSystemUser

Синтаксис

public virtual void ValidateDocumentRegisterForSystemUser(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateDocumentRegisterIsUnchanged

Синтаксис

public virtual void ValidateDocumentRegisterIsUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateDocumentTrackingIsUnchanged

Синтаксис

public virtual void ValidateDocumentTrackingIsUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateMarksDataBeforeConversion

Проверить свойства документа, необходимые для простановки отметок.

Синтаксис

[Remote]

public virtual Structures.OfficialDocument.IConversionToPdfResult ValidateMarksDataBeforeConversion(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат проверки свойств документа.

ValidateOffDocBeforeSave

Синтаксис

public virtual void ValidateOffDocBeforeSave(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegistrationDataIsUnchanged

Синтаксис

public virtual void ValidateRegistrationDataIsUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegistrationDateUnchanged

Синтаксис

public virtual void ValidateRegistrationDateUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegistrationNumberUnchanged

Синтаксис

public virtual void ValidateRegistrationNumberUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegistrationStateUnchanged

Синтаксис

public virtual void ValidateRegistrationStateUnchanged(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegNumberFormat

Синтаксис

public virtual void ValidateRegNumberFormat(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateRegNumberUniqueness

Синтаксис

public virtual void ValidateRegNumberUniqueness(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateReturnedDocumentResults

Синтаксис

public virtual void ValidateReturnedDocumentResults(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateReturnFromCounterparty

Синтаксис

public virtual void ValidateReturnFromCounterparty(Sungero.Domain.BeforeSaveEventArgs e)

Параметры

e

ValidateVersionBeforeConversion

Проверить версию документа перед преобразованием в PDF.

Синтаксис

public virtual Structures.OfficialDocument.IConversionToPdfResult ValidateVersionBeforeConversion(long versionId)

Параметры

versionId – ИД версии документа.

Возвращаемое значение

Structures.OfficialDocument.IConversionToPdfResult – Результат проверки версии.

WriteBytesToDocumentLastVersionBody

Записать тело документа из массива байт в версию.

Синтаксис

[Public]

public virtual void WriteBytesToDocumentLastVersionBody(Docflow.Structures.Module.IByteArray bytes, string extension)

Параметры

bytes – Структура с телом документа в виде массива байт;

extension – Расширение приложения-обработчика.

WriteConvertedBodyToVersion

Записать результат преобразования документа.

Синтаксис

public virtual void WriteConvertedBodyToVersion(Structures.Module.IDocumentMarksDto documentWithMarks)

Параметры

documentWithMarks – Структура с преобразованным телом документа.

WriteStatusChangeHistory

Записать историю смены состояний.

Синтаксис

public void WriteStatusChangeHistory(Sungero.Content.DocumentHistoryEventArgs e, System.Collections.Generic.IEnumerable<Sungero.Docflow.Structures.OfficialDocument.HistoryOperation> operations, bool historyRecordOverwritten)

Параметры

e – Аргументы события "До сохранения истории";

operations – Изменения значений статусов;

historyRecordOverwritten – Признак, что операция истории уже была перезаписана.

© Компания Directum, 2024