public record ComplianceRuleInfo
Static description of a rule (stable ComplianceRuleInfo.Id, citation, default severity).
Constructors
| Signature | Description |
|---|
# ComplianceRuleInfo(string Id, string Title, ComplianceSeverity DefaultSeverity, string Source, string Description, bool Advisory = false, string? HelpUri = default) | Static description of a rule (stable ComplianceRuleInfo.Id, citation, default severity). Id: Stable code, e.g. "ZPL3101". Custom rules should use an own prefix (e.g. "ACME001"). · Title: Short name shown in reports. · DefaultSeverity: Severity of findings unless the rule reports another one or options override it. · Source: Citation of the requirement (document, release, section), e.g. "GS1 General Specifications 26.0 §5.4.4.2". · Description: What the rule checks and how (one or two sentences). · Advisory: True when the value is a recommendation ("should") or could not be verified from a primary source; such findings never claim a violation of a hard requirement. · HelpUri: Public URL of the source, if any. |
Properties
| Property | Type | Description |
|---|
Advisory { get; init; } | bool | True when the value is a recommendation ("should") or could not be verified from a primary source; such findings never claim a violation of a hard requirement. |
DefaultSeverity { get; init; } | ComplianceSeverity | Severity of findings unless the rule reports another one or options override it. |
Description { get; init; } | string | What the rule checks and how (one or two sentences). |
HelpUri { get; init; } | string | Public URL of the source, if any. |
Id { get; init; } | string | Stable code, e.g. "ZPL3101". Custom rules should use an own prefix (e.g. "ACME001"). |
Source { get; init; } | string | Citation of the requirement (document, release, section), e.g. "GS1 General Specifications 26.0 §5.4.4.2". |
Title { get; init; } | string | Short name shown in reports. |
Methods
| Method Signature | Returns | Description |
|---|
# Deconstruct(out string Id, out string Title, out ComplianceSeverity DefaultSeverity, out string Source, out string Description, out bool Advisory, out string HelpUri) | void | |
