Class ReportBatchJsonAdapter

Bridges the JSON wire format for batch report operations to the in-memory editor: it deserializes batch requests and report documents (JSON or XML), maps them to editor operations, applies or validates them against a report, and serializes the results back to JSON.

Inheritance

object

ReportBatchJsonAdapter

Implements

IReportBatchJsonAdapter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Reportman.Reporting.Design.Json

Assembly: Reportman.Reporting.Design.Json.dll

Syntax

public class ReportBatchJsonAdapter : IReportBatchJsonAdapter

Constructors

ReportBatchJsonAdapter()

Declaration

public ReportBatchJsonAdapter()

ReportBatchJsonAdapter(IReportBatchEditor)

Declaration

public ReportBatchJsonAdapter(IReportBatchEditor editor)

Parameters

Type	Name	Description
IReportBatchEditor	editor

Methods

Apply(Report, ReportBatchJsonRequest)

Declaration

public ReportBatchApplyResult Apply(Report report, ReportBatchJsonRequest request)

Parameters

Type	Name	Description
Report	report
ReportBatchJsonRequest	request

Returns

Type	Description
ReportBatchApplyResult

Apply(Report, string)

Declaration

public ReportBatchApplyResult Apply(Report report, string json)

Parameters

Type	Name	Description
Report	report
string	json

Returns

Type	Description
ReportBatchApplyResult

ApplyReportDocument(string, string)

Declaration

public ReportBatchJsonDocumentApplyResponse ApplyReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
ReportBatchJsonDocumentApplyResponse

ApplyReportDocument(string, string, ReportDocumentFormat)

Declaration

public 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

public string ApplyReportDocumentToReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
string

ApplyReportDocumentToReportDocument(string, string, ReportDocumentFormat)

Declaration

public 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

public ReportBatchJsonDocumentApplyResponse ApplyReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
ReportBatchJsonDocumentApplyResponse

ApplyReportJsonToReportJson(string, string)

Declaration

public string ApplyReportJsonToReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
string

DeserializeReport(string)

Declaration

public Report DeserializeReport(string reportJson)

Parameters

Type	Name	Description
string	reportJson

Returns

Type	Description
Report

DeserializeReport(string, ReportDocumentFormat)

Declaration

public Report DeserializeReport(string reportDocument, ReportDocumentFormat format)

Parameters

Type	Name	Description
string	reportDocument
ReportDocumentFormat	format

Returns

Type	Description
Report

DeserializeReportDocument(string)

Declaration

public Report DeserializeReportDocument(string reportDocument)

Parameters

Type	Name	Description
string	reportDocument

Returns

Type	Description
Report

DeserializeRequest(string)

Declaration

public ReportBatchJsonRequest DeserializeRequest(string json)

Parameters

Type	Name	Description
string	json

Returns

Type	Description
ReportBatchJsonRequest

SerializeApplyResult(ReportBatchApplyResult)

Declaration

public string SerializeApplyResult(ReportBatchApplyResult result)

Parameters

Type	Name	Description
ReportBatchApplyResult	result

Returns

Type	Description
string

SerializeDocumentApplyResult(ReportBatchJsonDocumentApplyResponse)

Declaration

public string SerializeDocumentApplyResult(ReportBatchJsonDocumentApplyResponse result)

Parameters

Type	Name	Description
ReportBatchJsonDocumentApplyResponse	result

Returns

Type	Description
string

SerializeReport(Report)

Declaration

public string SerializeReport(Report report)

Parameters

Type	Name	Description
Report	report

Returns

Type	Description
string

SerializeReport(Report, ReportDocumentFormat)

Declaration

public string SerializeReport(Report report, ReportDocumentFormat format)

Parameters

Type	Name	Description
Report	report
ReportDocumentFormat	format

Returns

Type	Description
string

SerializeRequest(ReportBatchJsonRequest)

Declaration

public string SerializeRequest(ReportBatchJsonRequest request)

Parameters

Type	Name	Description
ReportBatchJsonRequest	request

Returns

Type	Description
string

SerializeValidationResult(ReportBatchValidationResult)

Declaration

public string SerializeValidationResult(ReportBatchValidationResult result)

Parameters

Type	Name	Description
ReportBatchValidationResult	result

Returns

Type	Description
string

ToOperations(ReportBatchJsonRequest)

Declaration

public IReadOnlyList<ReportBatchOperation> ToOperations(ReportBatchJsonRequest request)

Parameters

Type	Name	Description
ReportBatchJsonRequest	request

Returns

Type	Description
IReadOnlyList<ReportBatchOperation>

Validate(Report, ReportBatchJsonRequest)

Declaration

public ReportBatchValidationResult Validate(Report report, ReportBatchJsonRequest request)

Parameters

Type	Name	Description
Report	report
ReportBatchJsonRequest	request

Returns

Type	Description
ReportBatchValidationResult

Validate(Report, string)

Declaration

public ReportBatchValidationResult Validate(Report report, string json)

Parameters

Type	Name	Description
Report	report
string	json

Returns

Type	Description
ReportBatchValidationResult

ValidateReportDocument(string, string)

Declaration

public ReportBatchValidationResult ValidateReportDocument(string reportDocument, string operationsJson)

Parameters

Type	Name	Description
string	reportDocument
string	operationsJson

Returns

Type	Description
ReportBatchValidationResult

ValidateReportDocument(string, string, ReportDocumentFormat)

Declaration

public 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

public ReportBatchValidationResult ValidateReportJson(string reportJson, string operationsJson)

Parameters

Type	Name	Description
string	reportJson
string	operationsJson

Returns

Type	Description
ReportBatchValidationResult

Implements

IReportBatchJsonAdapter