Interface IReportBatchJsonAdapter

Bridges JSON batch contracts and the in-memory report model: implementers deserialize requests and reports, validate and apply batches of operations, and serialize reports and result objects back to JSON in the supported document formats.

Namespace: Reportman.Reporting.Design.Json

Assembly: Reportman.Reporting.Design.Json.dll

Syntax

public interface IReportBatchJsonAdapter

Methods

Apply(Report, ReportBatchJsonRequest)

Declaration

ReportBatchApplyResult Apply(Report report, ReportBatchJsonRequest request)

Parameters

Type	Name	Description
Report	report
ReportBatchJsonRequest	request

Returns

Type	Description
ReportBatchApplyResult

Apply(Report, string)

Declaration

ReportBatchApplyResult Apply(Report report, string json)

Parameters

Type	Name	Description
Report	report
string	json

Returns

Type	Description
ReportBatchApplyResult

ApplyReportDocument(string, string)

Declaration

ReportBatchJsonDocumentApplyResponse ApplyReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
ReportBatchJsonDocumentApplyResponse

ApplyReportDocument(string, string, ReportDocumentFormat)

Declaration

ReportBatchJsonDocumentApplyResponse ApplyReportDocument(string reportDocument, string operationsJson, ReportDocumentFormat format)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson
ReportDocumentFormat	format

Returns

Type	Description
ReportBatchJsonDocumentApplyResponse

ApplyReportDocumentToReportDocument(string, string)

Declaration

string ApplyReportDocumentToReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
string

ApplyReportDocumentToReportDocument(string, string, ReportDocumentFormat)

Declaration

string ApplyReportDocumentToReportDocument(string reportDocument, string operationsJson, ReportDocumentFormat format)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson
ReportDocumentFormat	format

Returns

Type	Description
string

ApplyReportJson(string, string)

Declaration

ReportBatchJsonDocumentApplyResponse ApplyReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
ReportBatchJsonDocumentApplyResponse

ApplyReportJsonToReportJson(string, string)

Declaration

string ApplyReportJsonToReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
string

DeserializeReport(string)

Declaration

Report DeserializeReport(string reportJson)

Parameters

Type	Name	Description
string	reportJson

Returns

Type	Description
Report

DeserializeReport(string, ReportDocumentFormat)

Declaration

Report DeserializeReport(string reportDocument, ReportDocumentFormat format)

Parameters

Type	Name	Description
string	reportDocument
ReportDocumentFormat	format

Returns

Type	Description
Report

DeserializeReportDocument(string)

Declaration

Report DeserializeReportDocument(string reportDocument)

Parameters

Type	Name	Description
string	reportDocument

Returns

Type	Description
Report

DeserializeRequest(string)

Declaration

ReportBatchJsonRequest DeserializeRequest(string json)

Parameters

Type	Name	Description
string	json

Returns

Type	Description
ReportBatchJsonRequest

SerializeApplyResult(ReportBatchApplyResult)

Declaration

string SerializeApplyResult(ReportBatchApplyResult result)

Parameters

Type	Name	Description
ReportBatchApplyResult	result

Returns

Type	Description
string

SerializeDocumentApplyResult(ReportBatchJsonDocumentApplyResponse)

Declaration

string SerializeDocumentApplyResult(ReportBatchJsonDocumentApplyResponse result)

Parameters

Type	Name	Description
ReportBatchJsonDocumentApplyResponse	result

Returns

Type	Description
string

SerializeReport(Report)

Declaration

string SerializeReport(Report report)

Parameters

Type	Name	Description
Report	report

Returns

Type	Description
string

SerializeReport(Report, ReportDocumentFormat)

Declaration

string SerializeReport(Report report, ReportDocumentFormat format)

Parameters

Type	Name	Description
Report	report
ReportDocumentFormat	format

Returns

Type	Description
string

SerializeRequest(ReportBatchJsonRequest)

Declaration

string SerializeRequest(ReportBatchJsonRequest request)

Parameters

Type	Name	Description
ReportBatchJsonRequest	request

Returns

Type	Description
string

SerializeValidationResult(ReportBatchValidationResult)

Declaration

string SerializeValidationResult(ReportBatchValidationResult result)

Parameters

Type	Name	Description
ReportBatchValidationResult	result

Returns

Type	Description
string

ToOperations(ReportBatchJsonRequest)

Declaration

IReadOnlyList<ReportBatchOperation> ToOperations(ReportBatchJsonRequest request)

Parameters

Type	Name	Description
ReportBatchJsonRequest	request

Returns

Type	Description
IReadOnlyList<ReportBatchOperation>

Validate(Report, ReportBatchJsonRequest)

Declaration

ReportBatchValidationResult Validate(Report report, ReportBatchJsonRequest request)

Parameters

Type	Name	Description
Report	report
ReportBatchJsonRequest	request

Returns

Type	Description
ReportBatchValidationResult

Validate(Report, string)

Declaration

ReportBatchValidationResult Validate(Report report, string json)

Parameters

Type	Name	Description
Report	report
string	json

Returns

Type	Description
ReportBatchValidationResult

ValidateReportDocument(string, string)

Declaration

ReportBatchValidationResult ValidateReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
ReportBatchValidationResult

ValidateReportDocument(string, string, ReportDocumentFormat)

Declaration

ReportBatchValidationResult ValidateReportDocument(string reportDocument, string operationsJson, ReportDocumentFormat format)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson
ReportDocumentFormat	format

Returns

Type	Description
ReportBatchValidationResult

ValidateReportJson(string, string)

Declaration

ReportBatchValidationResult ValidateReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
ReportBatchValidationResult