Click or drag to resize

ItemloadAML Method

This loads the dom property for the Item object with the passed AML. The method will also set the node and nodeList properties for the Item object according to the content of the loaded AML.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 14.0.20.39432
Syntax
public void loadAML(
	string AML
)

Parameters

AML
Type: SystemString
String with AML script. For more details on format of AML please read "Innovator Programmer's Guide".
Exceptions
ExceptionCondition
XmlExceptionThere is a load or parse error in the AML. Item remains uninitialized.
Remarks
In general, loaded AML could present any valid XmlDocument. However, user must follow one of supported AML formats in order to benefit from IOM public API. The most popular of supported AML formats are shown below:
  • AMLs representing a Single Innovator Item: (a) Item node as a root
    <Item >
          <prop1>a</prop1>
          ...
          <propN>b</propN>
    </Item>
    (b) SOAP-Result wrapper
    <SOAP-ENV:Envelope xmlns:SOAP-ENV=.../>
        <SOAP-ENV:Body>
            <Result>
                <Item >
                    <prop1>a</prop1>
                    ...
                    <propN>b</propN>
                </Item>
            </Result>
        </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
  • AMLs representing a Set of Innovator Items: (a) AML node as a root
    <AML>
        <Item ... />
         ...
        <Item ... />
    </AML>
    (b) SOAP-Result wrapper
    <SOAP-ENV:Envelope xmlns:SOAP-ENV=.../>
        <SOAP-ENV:Body>
            <Result>
                <Item >
                    <prop1>a</prop1>
                    ...
                    <propN>b</propN>
                </Item>
                ...
                <Item >
                    <prop1>a</prop1>
                    ....
                    <propM>b</propM>
                </Item>
            </Result>
        </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
  • AML representing an Error:
    <SOAP-ENV:Envelope xmlns:SOAP-ENV=.../>
     <SOAP-ENV:Body>
        <SOAP-ENV:Fault>
           <faultcode>[int]</faultcode>
           <faultactor>...</faultactor>
           <detail><...></detail>
        </SOAP-ENV:Fault>
     </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
  • AML representing a SOAP-Result wrapper for an arbitrary Text:
    <SOAP-ENV:Envelope xmlns:SOAP-ENV=.../>
     <SOAP-ENV:Body>
        <Result>[text]</Result>
     </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
See Also