|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот > Регистрация и нумерация > DocumentRegister – журнал регистрации Разделяемые функции типа сущности DocumentRegister |
|
|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот > Регистрация и нумерация > DocumentRegister – журнал регистрации Разделяемые функции типа сущности DocumentRegister |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
virtual |
– |
Проверить возможность построения номера по разрезам журнала |
|
virtual |
– |
Проверить регистрационный номер на валидность |
|
static |
– |
Сформировать ошибку валидации |
|
virtual |
– |
Заполнить пример номера журнала в соответствии с форматом |
|
GenerateRegistrationNumber + перегрузки |
virtual |
[Public] |
Генерировать регистрационный номер для документа |
virtual |
– |
Генерировать регистрационный номер для диалога регистрации |
|
virtual |
– |
Генерировать префикс и постфикс регистрационного номера документа |
|
– |
[Public] |
Получить начало действия текущего периода журнала |
|
static |
– |
Проверить заполненность НОР и кода НОР |
|
static |
– |
Проверить заполненность дела |
|
– |
[Public] |
Получить день периода действия текущего журнала |
|
– |
[Public] |
Получить месяц периода действия текущего журнала |
|
– |
[Public] |
Получить квартал периода действия текущего журнала |
|
– |
[Public] |
Получить год периода действия текущего журнала |
|
static |
– |
Получить журнал по умолчанию для документа |
|
static |
– |
Проверить заполненность подразделения и кода подразделения |
|
static |
– |
Проверить заполненность кода вида документа |
|
– |
[Public] |
Получить конец действия текущего периода журнала |
|
– |
– |
Отфильтровать документопотоки согласно настройкам выбранной группы регистрации |
|
static |
– |
Получить индекс рег. номера |
|
virtual |
– |
Получить формат номера журнала регистрации для отчета |
|
virtual |
– |
Получить пример номера журнала в соответствии с форматом |
|
static |
– |
Проверить совпадение рег.номеров |
|
static |
– |
Выделить составные части рег.номера |
|
virtual |
– |
Установить обязательность свойств в зависимости от заполненных данных |
|
static |
[Public] |
Получить квартал |
Проверить возможность построения номера по разрезам журнала.
Синтаксис
public virtual string CheckDocumentRegisterSections(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
string – Сообщение об ошибке. Пустая строка, если возможно сформировать номер.
Проверить регистрационный номер на валидность.
Пример: 5/1-П/2020, где 5 - порядковый номер, П - индекс журнала, 2020 - год, /1 - корректировочный постфикс.
Синтаксис
public virtual string CheckRegistrationNumberFormat(DateTime? registrationDate, string registrationNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadDocNumber, bool searchCorrectingPostfix)
Параметры
registrationDate – Дата регистрации;
registrationNumber – Номер регистрации;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
leadDocNumber – Номер ведущего документа;
searchCorrectingPostfix – Искать корректировочный постфикс.
Возвращаемое значение
string – Сообщение об ошибке. Пустая строка, если номер соответствует журналу.
Сформировать ошибку валидации.
Синтаксис
public static string CreateValidationError(IDocumentRegister documentRegister, string errorModel)
Параметры
documentRegister – Журнал регистрации;
errorModel – Шаблон ошибки.
Возвращаемое значение
string – Ошибка валидации.
Заполнить пример номера журнала в соответствии с форматом.
Синтаксис
public virtual void FillValueExample()
Генерировать регистрационный номер для документа.
Перегрузки
Имя функции |
Описание |
Генерировать регистрационный номер для документа |
|
Генерировать регистрационный номер для документа |
GenerateRegistrationNumber (DateTime date, string index, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadingDocumentNumber)
Генерировать регистрационный номер для документа.
Синтаксис
[Public]
public virtual string GenerateRegistrationNumber(DateTime date, string index, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadingDocumentNumber)
Параметры
date – Дата регистрации;
index – Номер;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
leadingDocumentNumber – Номер ведущего документа.
Возвращаемое значение
string – Сгенерированный регистрационный номер.
GenerateRegistrationNumber (DateTime date, string index, string leadingDocumentNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string indexLeadingSymbol)
Генерировать регистрационный номер для документа.
Синтаксис
[Public]
public virtual string GenerateRegistrationNumber(DateTime date, string index, string leadingDocumentNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string indexLeadingSymbol)
Параметры
date – Дата регистрации;
index – Номер;
leadingDocumentNumber – Номер ведущего документа;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
indexLeadingSymbol – Символ для заполнения ведущих значений индекса в номере.
Возвращаемое значение
string – Сгенерированный регистрационный номер.
GenerateRegistrationNumberFromDialog
Генерировать регистрационный номер для диалога регистрации.
Синтаксис
public virtual string GenerateRegistrationNumberFromDialog(DateTime date, string index, string leadingDocumentNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string indexLeadingSymbol)
Параметры
date – Дата регистрации;
index – Номер;
leadingDocumentNumber – Номер ведущего документа;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
indexLeadingSymbol – Символ для заполнения ведущих значений индекса в номере.
Возвращаемое значение
string – Сгенерированный регистрационный номер.
GenerateRegistrationNumberPrefixAndPostfix
Генерировать префикс и постфикс регистрационного номера документа.
Синтаксис
public virtual Structures.DocumentRegister.RegistrationNumberParts GenerateRegistrationNumberPrefixAndPostfix(DateTime date, string leadingDocumentNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, bool counterpartyCodeIsMetasymbol)
Параметры
date – Дата;
leadingDocumentNumber – Ведущий документ;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
counterpartyCodeIsMetasymbol – Признак того, что код контрагента нужен в виде метасимвола.
Возвращаемое значение
Structures.DocumentRegister.RegistrationNumberParts – Сгенерированный регистрационный номер.
Получить начало действия текущего периода журнала.
Синтаксис
[Public]
public DateTime? GetBeginPeriod(DateTime registrationDate)
Параметры
registrationDate – Дата.
Возвращаемое значение
DateTime? – Начало периода, null для сквозной нумерации.
GetBusinessUnitValidationError
Проверить заполненность НОР и кода НОР.
Синтаксис
public static string GetBusinessUnitValidationError(IDocumentRegister documentRegister, IOfficialDocument document)
Параметры
documentRegister – Журнал;
document – Документ.
Возвращаемое значение
string – Текст ошибки, либо string.Empty.
Проверить заполненность дела.
Синтаксис
public static string GetCaseFileValidationError(IDocumentRegister documentRegister, IOfficialDocument document)
Параметры
documentRegister – Журнал;
document – Документ.
Возвращаемое значение
string – Текст ошибки, либо string.Empty.
Получить день периода действия текущего журнала.
Синтаксис
[Public]
public int GetCurrentDay(DateTime registrationDate)
Параметры
registrationDate – Текущая дата.
Возвращаемое значение
int – День периода для текущей даты.
Получить месяц периода действия текущего журнала.
Синтаксис
[Public]
public int GetCurrentMonth(DateTime registrationDate)
Параметры
registrationDate – Текущая дата.
Возвращаемое значение
int – Месяц периода для текущей даты.
Получить квартал периода действия текущего журнала.
Синтаксис
[Public]
public int GetCurrentQuarter(DateTime registrationDate)
Параметры
registrationDate – Текущая дата.
Возвращаемое значение
int – Квартал периода для текущей даты.
Получить год периода действия текущего журнала.
Синтаксис
[Public]
public int GetCurrentYear(DateTime registrationDate)
Параметры
registrationDate – Текущая дата.
Возвращаемое значение
int – Год периода для текущей даты.
Получить журнал по умолчанию для документа.
Журнал подбирается сначала из настройки регистрации, потом из персональных настроек пользователя.
Если в настройках не указан журнал, или указан недействующий, то вернётся первый журнал из доступных для документа.
Если доступных журналов несколько, то вернётся пустое значение.
Синтаксис
public static IDocumentRegister GetDefaultDocRegister(IOfficialDocument document, List<long> filteredDocRegistersIds, Enumeration? settingType)
Параметры
document – Документ;
filteredDocRegistersIds – Список ИД доступных журналов;
settingType – Тип настройки.
Возвращаемое значение
IDocumentRegister – Журнал регистрации по умолчанию.
Проверить заполненность подразделения и кода подразделения.
Синтаксис
public static string GetDepartmentValidationError(IDocumentRegister documentRegister, IOfficialDocument document)
Параметры
documentRegister – Журнал;
document – Документ.
Возвращаемое значение
string – Текст ошибки, либо string.Empty.
GetDocumentKindValidationError
Проверить заполненность кода вида документа.
Синтаксис
public static string GetDocumentKindValidationError(IDocumentRegister documentRegister, IOfficialDocument document)
Параметры
documentRegister – Журнал;
document – Документ.
Возвращаемое значение
string – Текст ошибки, либо string.Empty.
Получить конец действия текущего периода журнала.
Синтаксис
[Public]
public DateTime? GetEndPeriod(DateTime registrationDate)
Параметры
registrationDate – Дата.
Возвращаемое значение
DateTime? – Конец периода, null для сквозной нумерации.
Отфильтровать документопотоки согласно настройкам выбранной группы регистрации.
Синтаксис
public List<Enumeration> GetFilteredDocumentFlows(IQueryable<Enumeration> query)
Параметры
query – Все доступные документопотоки.
Возвращаемое значение
List<Enumeration> – Отфильтрованные документопотоки.
GetIndexFromRegistrationNumber
Получить индекс рег. номера.
Пример: 5/1-П/2020, где 5 - порядковый номер, П - индекс журнала, 2020 - год, /1 - корректировочный постфикс.
Синтаксис
public static int GetIndexFromRegistrationNumber(IDocumentRegister documentRegister, DateTime date, string registrationNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadDocNumber, bool searchCorrectingPostfix)
Параметры
documentRegister – Журнал;
date – Дата;
registrationNumber – Рег. номер;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
leadDocNumber – Номер ведущего документа;
searchCorrectingPostfix – Искать корректировочный постфикс.
Возвращаемое значение
int – Индекс.
Получить формат номера журнала регистрации для отчета.
Используется в SkippedNumbersReport.
Синтаксис
public virtual string GetReportNumberFormat()
Возвращаемое значение
string – Формат номера для отчета.
Получить пример номера журнала в соответствии с форматом.
Синтаксис
public virtual string GetValueExample()
Возвращаемое значение
string – Пример номера журнала.
Проверить совпадение рег.номеров.
Пример: 5/1-П/2020, где 5 - порядковый номер, П - индекс журнала, 2020 - год, /1 - корректировочный постфикс.
Синтаксис
public static bool IsEqualsRegistrationNumbers(IDocumentRegister documentRegister, DateTime date, string registrationNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadDocNumber, string registrationNumberSample, bool searchCorrectingPostfix)
Параметры
documentRegister – Журнал;
date – Дата;
registrationNumber – Рег. номер;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
leadDocNumber – Номер ведущего документа;
registrationNumberSample – Пример рег. номера;
searchCorrectingPostfix – Искать корректировочный постфикс.
Возвращаемое значение
bool – True, если совпадают.
Выделить составные части рег.номера.
Пример: 5/1-П/2020, где 5 - порядковый номер, П - индекс журнала, 2020 - год, /1 - корректировочный постфикс.
Синтаксис
public static Structures.DocumentRegister.RegistrationNumberIndex ParseRegistrationNumber(IDocumentRegister documentRegister, DateTime date, string registrationNumber, string departmentCode, string businessUnitCode, string caseFileIndex, string docKindCode, string counterpartyCode, string leadDocNumber, bool searchCorrectingPostfix)
Параметры
documentRegister – Журнал;
date – Дата;
registrationNumber – Рег. номер;
departmentCode – Код подразделения;
businessUnitCode – Код нашей организации;
caseFileIndex – Индекс дела;
docKindCode – Код вида документа;
counterpartyCode – Код контрагента;
leadDocNumber – Номер ведущего документа;
searchCorrectingPostfix – Искать корректировочный постфикс.
Возвращаемое значение
Structures.DocumentRegister.RegistrationNumberIndex – Индекс рег.номера.
Установить обязательность свойств в зависимости от заполненных данных.
Синтаксис
public virtual void SetRequiredProperties()
Получить квартал.
Синтаксис
[Public]
public static string ToQuarterString(DateTime date)
Параметры
date – Дата.
Возвращаемое значение
string – Квартал периода для текущей даты.
| © Компания Directum, 2024 |