Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

XMLElement

Provides methods for iterating through XML elements and mapping values to fields in a table.

You get an XMLElement object by calling the next() method of an XMLElementIterator object.

Parent Topic:XML APIs

XMLElement - getIterator(String xPath)

Returns an XMLElementIterator object for the XML element based on the specified parameter.

NameTypeDescription
xPathStringAn xPath-like expression that specifies where in the XMLElement object to start.
TypeDescription
XMLElementIteratorAn object that can be used to iterate over elements in the XMLElement object.

XMLElement - getIteratorOverAllChildren()

Returns an XMLElementIterator object that includes all sub-elements for the XML element based on the specified parameter.

NameTypeDescription
None  
TypeDescription
XMLElementIteratorAn object that can be used to iterate over elements in the XMLElement object.

XMLElement - valueFor(String tableName, String fieldName)

Specifies that the value of the element maps to the specified field in the specified table.

Calling this method on an element value tells the proxy that the value for this element maps to the specified field in the specified table. The proxy then checks if the field must be encrypted. If the table and field names are unknown, you can call the valueFor() method on a table and a field that are dynamically assigned based on the request.

NameTypeDescription
tableNameStringThe table name.
fieldNameStringThe field name.
TypeDescription
void 

XMLElement - encodedQueryFor(String tableName)

Specifies that the value of the element is an encoded query for the specified table.

Calling this function on an element tells the proxy that the value of the element is an Encoded query strings for the specified table. The proxy parses the encoded query and encrypts the fields in the encoded query that must be encrypted.

NameTypeDescription
tableNameStringThe table that you expect the query to run on.
TypeDescription
void 

XMLElement - getName()

Returns the element name.

NameTypeDescription
None  
TypeDescription
StringThe element name.

XMLElement - getAttributeValue(String attribute)

Returns the value of the specified attribute.

NameTypeDescription
attributeStringAttribute name.
TypeDescription
StringThe attribute value.