A TVerificationResult object stores information about failed data verification and is passed (serialised) from the Server to the Client. It is made to be stored in the TVerificationResultCollection. More...

Inheritance diagram for Ict.Common.Verification.TVerificationResult:

Public Member Functions
	TVerificationResult (object AResultContext, ErrCodeInfo AErrorCodeInfo, System.Guid ADataValidationRunID=new System.Guid())
	Constructor More...

	TVerificationResult (object AResultContext, String AResultText, TResultSeverity AResultSeverity, System.Guid ADataValidationRunID=new System.Guid())
	Constructor More...

	TVerificationResult (object AResultContext, String AResultText, String AResultCode, TResultSeverity AResultSeverity, System.Guid ADataValidationRunID=new System.Guid())
	Constructor More...

	TVerificationResult (String AResultContext, String AResultText, String AResultTextCaption, String AResultCode, TResultSeverity AResultSeverity, System.Guid ADataValidationRunID=new System.Guid())
	Constructor More...

	TVerificationResult (TScreenVerificationResult AScreenVerificationResult)
	Constructor More...

void	OverrideResultContext (object ANewResultContext)
	Overrides the ResultContext that the TVerificationResult was originally populated with. More...

void	OverrideResultText (string ANewResultText)
	Overrides the ResultText that the TVerificationResult was originally populated with. More...

void	OverrideResultTextCaption (string ANewResultTextCaption)
	Overrides the ResultTextCaption that the TVerificationResult was originally populated with. More...

Protected Attributes
object	FResultContext = String.Empty
	DB Field or other context that describes where the data verification failed (use '[ODBC ...]' instead to signal a database error (such as a failed call to a stored procedure) More...

String	FResultText = String.Empty
	Verification failure explanation More...

String	FResultTextCaption = String.Empty
	Verification failure caption More...

String	FResultCode = String.Empty
	Error code if verification failure More...

TResultSeverity	FResultSeverity
	Signals whether the verification failure prevented saving of data (critical) or the verification result is only for information purposes (noncritical). More...

bool	FControlValueUndoRequested = false
	Is true (or set to true) if the data validation code requests that the validated Control's value is undone. This is only useful for TScreenVerificationResults but needs to be declared in this Class to make the handling easier. More...

bool	FSuppressValidationToolTip = false
	Is true (or set to true) if the data validation code requests that the validation ToolTip should not be shown on the validated Control. This is only useful for TScreenVerificationResults but needs to be declared in this Class to make the handling easier. More...

System.Guid	FDataValidationRunID
	Data Validation Run ID. More...

Properties
object	ResultContext `[get]`
	Context of the Verification Result (where the Verification Result originated from). More...

String	ResultText `[get]`
	Text of the Verification Result. More...

String	ResultTextCaption `[get]`
	Caption of the Verification Result (e.g. for use in MessageBox Titles). More...

String	ResultCode `[get, set]`
	ResultCode of the Verification Result. More...

TResultSeverity	ResultSeverity `[get]`
	Severity of the Verification Result. More...

bool	ControlValueUndoRequested `[get, set]`
	Is true (or set to true) if the data validation code requests that the validated Control's value is undone. More...

bool	SuppressValidationToolTip `[get, set]`
	Is true (or set to true) if the data validation code requests that the validation ToolTip should not be shown on the validated Control. More...

System.Guid	DataValidationRunID `[get, set]`
	Data Validation Run ID. More...

Detailed Description

A TVerificationResult object stores information about failed data verification and is passed (serialised) from the Server to the Client. It is made to be stored in the TVerificationResultCollection.

Constructor & Destructor Documentation

◆ TVerificationResult() [1/5]

Ict.Common.Verification.TVerificationResult.TVerificationResult	(	object	AResultContext,
		ErrCodeInfo	AErrorCodeInfo,
		System.Guid	ADataValidationRunID = `new System.Guid()`
	)

inline

Constructor

Parameters

AResultContext	context where this verification happens (e.g. DB field name)
AErrorCodeInfo	An ErrCodeInfo that contains data which is used for populating the Verification Result's Properites.
ADataValidationRunID	A Data Validation Run ID that this instance should be associated with. Default: a new System.Guid instance.

◆ TVerificationResult() [2/5]

Ict.Common.Verification.TVerificationResult.TVerificationResult	(	object	AResultContext,
		String	AResultText,
		TResultSeverity	AResultSeverity,
		System.Guid	ADataValidationRunID = `new System.Guid()`
	)

inline

Constructor

Parameters

AResultContext	context where this verification happens (e.g. DB field name)
AResultText	Verification failure explanation
AResultSeverity	is this an error or just a warning
ADataValidationRunID	A Data Validation Run ID that this instance should be associated with. Default: a new System.Guid instance.

◆ TVerificationResult() [3/5]

Ict.Common.Verification.TVerificationResult.TVerificationResult	(	object	AResultContext,
		String	AResultText,
		String	AResultCode,
		TResultSeverity	AResultSeverity,
		System.Guid	ADataValidationRunID = `new System.Guid()`
	)

inline

Constructor

Parameters

AResultContext	context where this verification happens (e.g. DB field name)
AResultText	Verification failure explanation
AResultCode	a result code to identify error messages
AResultSeverity	is this an error or just a warning
ADataValidationRunID	A Data Validation Run ID that this instance should be associated with. Default: a new System.Guid instance.

◆ TVerificationResult() [4/5]

Ict.Common.Verification.TVerificationResult.TVerificationResult	(	String	AResultContext,
		String	AResultText,
		String	AResultTextCaption,
		String	AResultCode,
		TResultSeverity	AResultSeverity,
		System.Guid	ADataValidationRunID = `new System.Guid()`
	)

inline

Constructor

Parameters

AResultContext	context where this verification happens (e.g. DB field name)
AResultText	Verification failure explanation
AResultTextCaption	caption for message box
AResultCode	a result code to identify error messages
AResultSeverity	is this an error or just a warning
ADataValidationRunID	A Data Validation Run ID that this instance should be associated with. Default: a new System.Guid instance.

◆ TVerificationResult() [5/5]

Ict.Common.Verification.TVerificationResult.TVerificationResult ( TScreenVerificationResult AScreenVerificationResult )

inline

Constructor

'Downgrades' a TScreenVerificationResult to a TVerificationResult.

Parameters

AScreenVerificationResult A TScreenVerificationResult.

Member Function Documentation

◆ OverrideResultContext()

void Ict.Common.Verification.TVerificationResult.OverrideResultContext ( object ANewResultContext )

inline

Overrides the ResultContext that the TVerificationResult was originally populated with.

Parameters

ANewResultContext New ResultText.

◆ OverrideResultText()

void Ict.Common.Verification.TVerificationResult.OverrideResultText ( string ANewResultText )

inline

Overrides the ResultText that the TVerificationResult was originally populated with.

Parameters

ANewResultText New ResultText.

◆ OverrideResultTextCaption()

void Ict.Common.Verification.TVerificationResult.OverrideResultTextCaption ( string ANewResultTextCaption )

inline

Overrides the ResultTextCaption that the TVerificationResult was originally populated with.

Parameters

ANewResultTextCaption New ResultTextCaption.

Member Data Documentation

◆ FControlValueUndoRequested

bool Ict.Common.Verification.TVerificationResult.FControlValueUndoRequested = false

protected

Is true (or set to true) if the data validation code requests that the validated Control's value is undone. This is only useful for TScreenVerificationResults but needs to be declared in this Class to make the handling easier.

◆ FDataValidationRunID

System.Guid Ict.Common.Verification.TVerificationResult.FDataValidationRunID

protected

Data Validation Run ID.

◆ FResultCode

String Ict.Common.Verification.TVerificationResult.FResultCode = String.Empty

protected

Error code if verification failure

◆ FResultContext

object Ict.Common.Verification.TVerificationResult.FResultContext = String.Empty

protected

DB Field or other context that describes where the data verification failed (use '[ODBC ...]' instead to signal a database error (such as a failed call to a stored procedure)

◆ FResultSeverity

TResultSeverity Ict.Common.Verification.TVerificationResult.FResultSeverity

protected

Signals whether the verification failure prevented saving of data (critical) or the verification result is only for information purposes (noncritical).

◆ FResultText

String Ict.Common.Verification.TVerificationResult.FResultText = String.Empty

protected

Verification failure explanation

◆ FResultTextCaption

String Ict.Common.Verification.TVerificationResult.FResultTextCaption = String.Empty

protected

Verification failure caption

◆ FSuppressValidationToolTip

bool Ict.Common.Verification.TVerificationResult.FSuppressValidationToolTip = false

protected

Is true (or set to true) if the data validation code requests that the validation ToolTip should not be shown on the validated Control. This is only useful for TScreenVerificationResults but needs to be declared in this Class to make the handling easier.

Property Documentation

◆ ControlValueUndoRequested

bool Ict.Common.Verification.TVerificationResult.ControlValueUndoRequested

getset

Is true (or set to true) if the data validation code requests that the validated Control's value is undone.

◆ DataValidationRunID

System.Guid Ict.Common.Verification.TVerificationResult.DataValidationRunID

getset

Data Validation Run ID.

◆ ResultCode

String Ict.Common.Verification.TVerificationResult.ResultCode

getset

ResultCode of the Verification Result.

Implements Ict.Common.Verification.IResultInterface.

◆ ResultContext

object Ict.Common.Verification.TVerificationResult.ResultContext

get

Context of the Verification Result (where the Verification Result originated from).

This Property cannot be written to in order to avoid accidental overwriting. However, by calling the Method OverrideResultContext the ResultContext can be modified.

Implements Ict.Common.Verification.IResultInterface.

◆ ResultSeverity

TResultSeverity Ict.Common.Verification.TVerificationResult.ResultSeverity

get

Severity of the Verification Result.

Implements Ict.Common.Verification.IResultInterface.

◆ ResultText

String Ict.Common.Verification.TVerificationResult.ResultText

get

Text of the Verification Result.

This Property cannot be written to in order to avoid accidental overwriting. However, by calling the Method OverrideResultText the ResultText can be modified.

Implements Ict.Common.Verification.IResultInterface.

◆ ResultTextCaption

String Ict.Common.Verification.TVerificationResult.ResultTextCaption

get

Caption of the Verification Result (e.g. for use in MessageBox Titles).

This Property cannot be written to in order to avoid accidental overwriting. However, by calling the Method OverrideResultTextCaption the ResultTextCaption can be modified.

Implements Ict.Common.Verification.IResultInterface.

◆ SuppressValidationToolTip

bool Ict.Common.Verification.TVerificationResult.SuppressValidationToolTip

getset

Is true (or set to true) if the data validation code requests that the validation ToolTip should not be shown on the validated Control.

The documentation for this class was generated from the following file:

csharp/ICT/Common/Verification/Main.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TVerificationResult() [1/5]

◆ TVerificationResult() [2/5]

◆ TVerificationResult() [3/5]

◆ TVerificationResult() [4/5]

◆ TVerificationResult() [5/5]

Member Function Documentation

◆ OverrideResultContext()

◆ OverrideResultText()

◆ OverrideResultTextCaption()

Member Data Documentation

◆ FControlValueUndoRequested

◆ FDataValidationRunID

◆ FResultCode

◆ FResultContext

◆ FResultSeverity

◆ FResultText

◆ FResultTextCaption

◆ FSuppressValidationToolTip

Property Documentation

◆ ControlValueUndoRequested

◆ DataValidationRunID

◆ ResultCode

◆ ResultContext

◆ ResultSeverity

◆ ResultText

◆ ResultTextCaption

◆ SuppressValidationToolTip