Class HarmonizationResult

Describes the results of a deserialization process.

Inheritance

System.Object

HarmonizationResult

Namespace: Algenta.Colectica.Model.Utility

Assembly: Algenta.Colectica.Model.dll

Syntax

public class HarmonizationResult : object

Constructors

HarmonizationResult()

Initializes a new instance of the HarmonizationResult class.

Declaration

public HarmonizationResult()

Properties

Errors

Gets a collection of errors.

Declaration

public Collection<HarmonizationError> Errors { get; }

Property Value

Type	Description
Collection<HarmonizationError>

ItemsRenamed

Gets or sets the number of items that were renamed during the process.

Declaration

public long ItemsRenamed { get; set; }

Property Value

Type	Description
System.Int64

Messages

Gets a collection of messages.

Declaration

public Collection<HarmonizationError> Messages { get; }

Property Value

Type	Description
Collection<HarmonizationError>

ResultMessages

Returns the collected warning and error exceptions as a series of ResultMessages

Declaration

public Collection<ResultMessage> ResultMessages { get; }

Property Value

Type	Description
Collection<ResultMessage>

Success

Gets or sets a value indicating whether the process succeeded.

Declaration

public bool Success { get; set; }

Property Value

Type	Description
System.Boolean

Warnings

Gets a collection of warnings.

Declaration

public Collection<HarmonizationError> Warnings { get; }

Property Value

Type	Description
Collection<HarmonizationError>

Methods

AddError(String, Nullable<Int32>, String)

Adds an error to the result.

Declaration

public void AddError(string message, int ? lineNumber = null, string xpath = null)

Parameters

Type	Name	Description
System.String	message	The error message.
System.Nullable<System.Int32>	lineNumber	The line number at which the error occurred.
System.String	xpath	The XPath of the XML node that caused the error.

AddError(String, XElement)

Adds an error to the result.

Declaration

public void AddError(string message, XElement element)

Parameters

Type	Name	Description
System.String	message	The error message.
XElement	element	The XML element that caused the error.

AddError(String, XmlNode)

Adds an error to the result.

Declaration

public void AddError(string message, XmlNode node)

Parameters

Type	Name	Description
System.String	message	The error message.
XmlNode	node	The XML node that caused the error.

AddMessage(String, Nullable<Int32>, String)

Adds an informational message to the result.

Declaration

public void AddMessage(string message, int ? lineNumber = null, string xpath = null)

Parameters

Type	Name	Description
System.String	message	The message text.
System.Nullable<System.Int32>	lineNumber	The line number to which the message applies.
System.String	xpath	The XPath of the XML node that triggered the message.

AddMessage(String, XElement)

Adds an informational message to the result.

Declaration

public void AddMessage(string message, XElement element)

Parameters

Type	Name	Description
System.String	message	The informational message message.
XElement	element	The XML element that caused the error.

AddMessage(String, XmlNode)

Adds an informational message to the result.

Declaration

public void AddMessage(string message, XmlNode node)

Parameters

Type	Name	Description
System.String	message	The message text.
XmlNode	node	The XML node that triggered the message.

AddWarning(String, Nullable<Int32>, String)

Adds a warning to the result.

Declaration

public void AddWarning(string message, int ? lineNumber = null, string xpath = null)

Parameters

Type	Name	Description
System.String	message	The warning message.
System.Nullable<System.Int32>	lineNumber	The line number at which the warning occurred.
System.String	xpath	The XPath of the XML node that caused the warning.

AddWarning(String, XElement)

Adds an warning to the result.

Declaration

public void AddWarning(string message, XElement element)

Parameters

Type	Name	Description
System.String	message	The warning message.
XElement	element	The XML element that caused the error.

AddWarning(String, XmlNode)

Adds a warning to the result.

Declaration

public void AddWarning(string message, XmlNode node)

Parameters

Type	Name	Description
System.String	message	The warning message.
XmlNode	node	The XML node that caused the warning.

Extension Methods

Extensions.Yield<T>(T)