Click or drag to resize

IValidatorRESULTTYPE Interface

This service interface is defined for the validation of an AML document. The type parameter of this generic interface defined the validation result type.

Namespace: Aml.Engine.Services.Interfaces
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
Copy
public interface IValidator<RESULTTYPE> : IValidator, 
	IAMLService
where RESULTTYPE : IValidationResult

Type Parameters

RESULTTYPE
The type of the validation result

The IValidatorRESULTTYPE type exposes the following members.

Methods
 NameDescription
Public methodIDValidation Validates the ID of a CAEX object. IDs of CAEX objects shall be unique.
(Inherited from IValidator)
Public methodNameValidation Validates a name of a CAEX object. Names of CAEX classes or types (RoleClasses, InterfaceClasses, SystemUnitClasses and AttributeTypes), Attributes, Libraries and CAEX InstanceHierarchies shall be unique across its siblings or across all child elements of the same CAEX parent element over its life time. This shall assure that referencing a library, a class, a type or an attribute by its path delivers a unique result.
(Inherited from IValidator)
Public methodRepair Repairs the specified validated element.
Public methodValidateAliasReferences Validates the alias references and returns the validation result describing possible repair options. The IValidationResult provides detailed information about available Repair Options and an additional Information Text.
Public methodValidateAll(CAEXDocument, Boolean) Get Validation Information for all elements in the specified document, which have validation issues. The IValidationResult provides detailed information about available Repair Options and an additional Information Text.
Public methodValidateAll(CAEXDocument, AutomationMLContainer, Boolean) Get Validation Information for all elements in the specified document, which have validation issues. The IValidationResult provides detailed information about available Repair Options and an additional Information Text. This method should be used, if the Document is loaded from an AutomationML container. The Validation service will check validity of external references which are packed parts of the container.
Top
See Also