Table of Contents

Class AdapterFinding

Namespace
MES.MQC.DataSourceLibrary.Models.Adapters
Assembly
MES.MQC.DataSourceLibrary.dll

The AdapterFinding class contains the data for one data item to be imported. Each Adapter returns a List of with objects of this class on execution with the Read method.

public class AdapterFinding : AdapterDataBase
Inheritance
AdapterFinding
Inherited Members

Properties

AggregateData

Generate data from findings?

public bool AggregateData { get; set; }

Property Value

bool

DescriptionAsHtml

If the description is not plain text.

public bool DescriptionAsHtml { get; set; }

Property Value

bool

HumanReadableDisabled

If no human readable file path should be auto detected.

public bool HumanReadableDisabled { get; set; }

Property Value

bool

IssueMessageAsHtml

If the issue message is not plain text.

public bool IssueMessageAsHtml { get; set; }

Property Value

bool

Measure

Measure of the Finding (e.g. Result, Coverage of Testcases).

public string Measure { get; set; }

Property Value

string

MeasurementName

Name of Measurement, used to replace ${MeasurementName} in FindingStructure and FindingStructureForArtifact (after verified with adapter options).

public string MeasurementName { get; set; }

Property Value

string

SubjectType

Subject Type of the Finding (e.g. Requirement, Testcase, Check).

public string SubjectType { get; set; }

Property Value

string

ValidUntil

How long is the finding valid?

public DateTime? ValidUntil { get; set; }

Property Value

DateTime?

Variants

Variants of the Finding (VariableName)

public List<AdapterFindingVariant> Variants { get; set; }

Property Value

List<AdapterFindingVariant>

Methods

Add(List<AdapterFinding>, string, string, DateTime?, string, string, string, string[], string, string, string[], string[], string, string, string, string, AdapterFindingLocation, Dictionary<string, string>, DateTime?, bool, bool, bool, string, DateTime?, bool, DateTime?, bool)

public static AdapterFindingCombination Add(List<AdapterFinding> findings, string identifier, string dataSource, DateTime? dateTime, string subjectType, string measure, string artifactPath, string[] artifactInnerPath, string state, string subjectName, string[] subjectPath, string[] subjectPathForArtifact, string description = null, string issueMessage = null, string humanReadableFilePath = null, string humanReadableAnchor = null, AdapterFindingLocation location = null, Dictionary<string, string> metadata = null, DateTime? deadline = null, bool issueMessageAsHtml = false, bool descriptionAsHtml = false, bool humanReadableDisabled = false, string measurementName = null, DateTime? dataDateTime = null, bool ignoreDuplicates = false, DateTime? validUntil = null, bool aggregateData = false)

Parameters

findings List<AdapterFinding>
identifier string
dataSource string
dateTime DateTime?
subjectType string
measure string
artifactPath string
artifactInnerPath string[]
state string
subjectName string
subjectPath string[]
subjectPathForArtifact string[]
description string
issueMessage string
humanReadableFilePath string
humanReadableAnchor string
location AdapterFindingLocation
metadata Dictionary<string, string>
deadline DateTime?
issueMessageAsHtml bool
descriptionAsHtml bool
humanReadableDisabled bool
measurementName string
dataDateTime DateTime?
ignoreDuplicates bool
validUntil DateTime?
aggregateData bool

Returns

AdapterFindingCombination

AddVariant(string, string, string, string[], string[], string[], string, string, string, string, AdapterFindingLocation, Dictionary<string, string>, DateTime?, DateTime?, bool)

public AdapterFindingCombination AddVariant(string identifier, string state, string subjectName, string[] subjectPath, string[] subjectPathForArtifact, string[] artifactInnerPath, string description = null, string issueMessage = null, string humanReadableFilePath = null, string humanReadableAnchor = null, AdapterFindingLocation location = null, Dictionary<string, string> metadata = null, DateTime? deadline = null, DateTime? dataDateTime = null, bool ignoreDuplicates = false)

Parameters

identifier string
state string
subjectName string
subjectPath string[]
subjectPathForArtifact string[]
artifactInnerPath string[]
description string
issueMessage string
humanReadableFilePath string
humanReadableAnchor string
location AdapterFindingLocation
metadata Dictionary<string, string>
deadline DateTime?
dataDateTime DateTime?
ignoreDuplicates bool

Returns

AdapterFindingCombination