Interface ITechReportTemplatesRepository

Представляет хранилище шаблонов отчетов.

Namespace: Ascon.Vertical.Core

Assembly: Ascon.Vertical.Core.dll

Syntax

public interface ITechReportTemplatesRepository

Methods

Add(TechReportTemplatesRepositoryEntryDto, CancellationToken)

Создает шаблон ТД в хранилище по описанию.

Declaration

Task<int> Add(TechReportTemplatesRepositoryEntryDto entryDto, CancellationToken cancellationToken)

Parameters

Type	Name	Description
TechReportTemplatesRepositoryEntryDto	entryDto	Описание шаблона ТД.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<int>	Созданный шаблон ТД.

GetAll(CancellationToken)

Возвращает полный перечень шаблонов отчетов.

Declaration

Task<IReadOnlyList<ITechReportTemplatesRepositoryEntry>> GetAll(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechReportTemplatesRepositoryEntry>>	Перечень описаний шаблонов.

GetAllWithFileNames(CancellationToken)

Возвращает полный перечень шаблонов отчетов вместе с именами файлов.

Declaration

Task<IReadOnlyList<ITechReportTemplatesRepositoryEntryEx>> GetAllWithFileNames(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechReportTemplatesRepositoryEntryEx>>	Перечень описаний шаблонов.

GetById(int, CancellationToken)

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

Declaration

Task<ITechReportTemplatesRepositoryEntry?> GetById(int entryId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	entryId	Идентификатор объекта типа "Шаблон ТД" в БД Лоцман.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechReportTemplatesRepositoryEntry>	Описание шаблона.

GetByKey(Guid, CancellationToken)

Возвращает шаблон по ключу.

Declaration

Task<ITechReportTemplatesRepositoryEntry?> GetByKey(Guid entryKey, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Guid	entryKey	Ключ шаблона.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechReportTemplatesRepositoryEntry>	Описание шаблона.

GetByName(string, CancellationToken)

Возвращает шаблон по наименованию.

Declaration

Task<ITechReportTemplatesRepositoryEntry?> GetByName(string entryName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	entryName	Наименование шаблона.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechReportTemplatesRepositoryEntry>	Описание шаблона.

GetDocument(int, CancellationToken)

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

Declaration

Task<byte[]?> GetDocument(int entryId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	entryId	Идентификатор объекта типа "Шаблон ТД" в БД Лоцман.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<byte[]>	Содержимое файла шаблона.

GetDocuments(IEnumerable<int>, CancellationToken)

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

Declaration

Task<byte[]?> GetDocuments(IEnumerable<int> entryIds, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<int>	entryIds	Идентификаторы объектов типа "Шаблон ТД" в БД Лоцман.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<byte[]>	Содержимое файлов шаблонов.

GetTemplatesPackageItems(int, CancellationToken)

Возвращает шаблоны ТД, входящие в состав комплекта шаблонов ТД.

Declaration

Task<IReadOnlyList<ITechReportTemplatesRepositoryEntry>> GetTemplatesPackageItems(int templatesPackageId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	templatesPackageId	Идентификатор комплекта шаблонов ТД.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechReportTemplatesRepositoryEntry>>	Перечень описаний шаблонов.

SetDocument(ITechObject, byte[], CancellationToken)

Записывает документ шаблона ТД в хранилище.

Declaration

Task SetDocument(ITechObject template, byte[] data, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	template	Объект шаблона ТД.
byte[]	data	Содержимое файла шаблона.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task	Выполняемую задачу.

Update(ITechObject, TechReportTemplatesRepositoryEntryDto, CancellationToken)

Обновляет параметры шаблона ТД в хранилище.

Declaration

Task Update(ITechObject template, TechReportTemplatesRepositoryEntryDto entryDto, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	template	Объект шаблона ТД.
TechReportTemplatesRepositoryEntryDto	entryDto	Описание шаблона ТД.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task	Выполняемую задачу.