Class ReportBuilderRepository

Хранилище файлов формирователя.

Inheritance

object

ReportBuilderRepository

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Ascon.Vertical.Reports.Builder

Assembly: Ascon.Vertical.Reports.Builder.dll

Syntax

public class ReportBuilderRepository

Constructors

ReportBuilderRepository(string)

Создаёт экземпляр класса ReportBuilderRepository.

Declaration

public ReportBuilderRepository(string repositoryPath)

Parameters

Type	Name	Description
string	repositoryPath	Путь к папке, содержашщей файлы.

Properties

RepositoryPath

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

Declaration

public string RepositoryPath { get; }

Property Value

Type	Description
string

Methods

AddEssentials(ComplectEssentials, CancellationToken)

Добавляет статистику в хранилище.

Declaration

public Task AddEssentials(ComplectEssentials essentials, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ComplectEssentials	essentials	Статистика формирования.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

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

AddPresentationModel(PresentationModelDto, CancellationToken)

Добавляет модель представления в хранилище.

Declaration

public Task AddPresentationModel(PresentationModelDto presentationModel, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PresentationModelDto	presentationModel	Модель представления.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

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

AddReport(Document, CancellationToken)

Добавляет документ отчета в хранилище.

Declaration

public Task<string[]> AddReport(Document report, CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<string[]>	Перечень имен сохраненных файлов.

AddReportBuilderConfiguration(string, CancellationToken)

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

Declaration

public Task AddReportBuilderConfiguration(string configuration, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	configuration	Параметры формирователя.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

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

AddReportBuilderContext(ReportBuilderContextDto, CancellationToken)

Добавляет контекст формирования в хранилище.

Declaration

public Task AddReportBuilderContext(ReportBuilderContextDto context, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ReportBuilderContextDto	context	Контекст формирования.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

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

AddTableOfContents(TechReportBuilderResultsDto, CancellationToken)

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

Declaration

public Task AddTableOfContents(TechReportBuilderResultsDto contents, CancellationToken cancellationToken)

Parameters

Type	Name	Description
TechReportBuilderResultsDto	contents	Описание документов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

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

GetEssentials(CancellationToken)

Возвращает статистику формирования, которая хранится в хранилище.

Declaration

public Task<byte[]?> GetEssentials(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<byte[]>	Массив байт, содержащий статистику формирования.

GetFile(string, CancellationToken)

Возвращает содержимое файла.

Declaration

public Task<byte[]?> GetFile(string fileName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	fileName	Имя файла.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<byte[]>	Набор байт. Если отчет не найден - Null.

GetFilesNames(CancellationToken)

Возвращает наименования файлов, которые хранятся в хранилище.

Declaration

public Task<IReadOnlyCollection<string>> GetFilesNames(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<IReadOnlyCollection<string>>	Наименования файлов, которые хранятся в хранилище.

GetPresentationModel(CancellationToken)

Возвращает модель представления, которая хранится в хранилище.

Declaration

public Task<PresentationModelDto?> GetPresentationModel(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<PresentationModelDto>	Модель представления.

GetReportBuilderConfiguration(CancellationToken)

Возвращает параметры формирователя, которые хранятся в хранилище.

Declaration

public Task<string?> GetReportBuilderConfiguration(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<string>	Параметры формирователя.

GetReportBuilderContext(CancellationToken)

Возвращает контекст формирования, который хранится в хранилище.

Declaration

public Task<ReportBuilderContextDto?> GetReportBuilderContext(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<ReportBuilderContextDto>	Контекст формирования.

GetTableOfContents(CancellationToken)

Возвращает описание результатов формирования отчета, включая перечень единичных отчетов.

Declaration

public Task<TechReportBuilderResultsDto?> GetTableOfContents(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<TechReportBuilderResultsDto>	Описание результатов формирования отчета.

OpenFile(string)

Возвращает поток файла.

Declaration

public Stream OpenFile(string name)

Parameters

Type	Name	Description
string	name	Имя файла.

Returns

Type	Description
Stream	Поток с содержимым файла.

Exceptions

Type	Condition
NotFoundException	Файл с указанным именем не найден.