Class Violation

A violation found when validating rules

Inheritance

System.Object

Violation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Microsoft.CST.OAT

Assembly: OAT.dll

Syntax

public class Violation

Constructors

Violation(String, Rule)

Simplest constructor.

Arguments may not be null.

Declaration

public Violation(string description, Rule rule)

Parameters

Type	Name	Description
System.String	description	The description for the violation.
Rule	rule	The Rule the violation references

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when any parameter is null.

Violation(String, Rule, Clause)

Use this constructor if you have only a single clause

Arguments may not be null.

Declaration

public Violation(string description, Rule rule, Clause clause)

Parameters

Type	Name	Description
System.String	description	The description for the violation.
Rule	rule	The Rule the violation references
Clause	clause	The Clause the violation references

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when any parameter is null.

Violation(String, Rule, Clause[])

Use this constructor if you have multiple clauses.

Arguments may not be null.

Declaration

public Violation(string description, Rule rule, Clause[] clauses)

Parameters

Type	Name	Description
System.String	description	The description for the violation.
Rule	rule	The Rule the violation references
Clause[]	clauses	The Clauses the violation references

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when any parameter is null.

Properties

Clauses

The clauses associated with this violation

Declaration

public Clause[] Clauses { get; set; }

Property Value

Type	Description
Clause[]

Description

The text description of the violation

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Rule

The Rule associated with this violation

Declaration

public Rule Rule { get; set; }

Property Value

Type	Description
Rule