 | External |
This class provides methods to create and retrieve external data references as it is defined in the BPR document
"ExternalDataReference" Version 1.0.0 from July 2016.
Inheritance HierarchyNamespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
SyntaxThe ExternalDataReference type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddAutomationMLBPRInterfaceClassLib | Adds the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument. |
| AddAutomationMLBPRRoleClassLib | Adds the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument. |
| AddDocumentElement | Adds a document element to the defined internalElement. A Document Element is semantically described with an attached role defined with the base role class ExternalDataRoleClassPath or a derived role class. If no role class path is given as a parameter the default is used. If the specified role class path can not be identified as a derived role from the ExternalDataRoleClassPath no document element is added (returns null). |
| AddDocumentElementRole | Add a role reference to a external data role class or derived role class defined with the given role class path as a supported role class to the internal element. If the specified role class path can not be identified as a derived role from the ExternalDataRoleClassPath no role reference is added (returns false). |
| AddDocumentReference | Adds a document with the specified external reference interface to the document element. If the given internal element is not a document element or the defined class path to the external reference interface is not derived from the standard base class no interface is added. |
| AddExternalDataReferenceLibraries | Adds the external data reference libraries used to model external document references. It is checked, if the needed role- and interface libraries are contained in the AMLDocument. If this libs are missing, they are imported from an embedded resource stream. The current Version of the embedded libs is version 1.0.0. |
| AddLanguage | Adds a language attribute to the internal element. If this is the first language attribute, a simple attribute is added. If this is not the first, a language attribute list is used. A former created simple attribute is transferred to a list item. |
| AutomationMLBPRInterfaceClassLib | Gets the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument. |
| AutomationMLBPRRoleClassLib | Gets the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument. |
| DocumentElements | Gets all Internal Element Children from the specified internal element which are document elements. |
| ExternalDataReferenceInterfaceClass(CAEXFileType) | Gets the 'ExternalDataReference' InterfaceClass from the AML document. |
| ExternalDataReferenceInterfaceClass(InterfaceClassLibType) | Gets the ExternalDataReference InterfaceClass from the AutomationMLBPRInterfaceClassLib. |
| ExternalDataRoleClass(CAEXFileType) | Gets the ExternalData RoleClass from the AML document. ExternalData RoleClass is only defined for CAEX 2.15 and AutomationML 2.0 |
| ExternalDataRoleClass(RoleClassLibType) | Gets the 'ExternalData' RoleClass from the AutomationMLBPRRoleClassLib. |
| GetLanguages | Gets the languages, defined for the document element. If the given internal element is not a document element, the collection is empty. |
| IsDocumentElement | Determines whether the specified internal element is a document element. |
Fields| Name | Description | |
|---|---|---|
  | AutomationMLBPRInterfaceClassLibName | The name of the library containing interface classes specified in BPR documents |
| AutomationMLBPRRoleClassLibName | The name of the library containing role classes specified in BPR documents |
| ExternalDataReferenceInterfaceClassName | The name for the ExternalDataReference interface class |
| ExternalDataReferenceInterfaceClassPath | The class path for the ExternalDataReference interface class |
| ExternalDataRoleClassName | The name for the ExternalData role class |
| ExternalDataRoleClassPath | The class path for the ExternalData role class |
| LanguageAttributeName | The language attribute name |
See Also