com.ebasetech.xi.api

Interface Fields

All Superinterfaces:

java.lang.Iterable<Field>

public interface Fields
extends java.lang.Iterable<Field>

The Fields interface acts as a parent object for all fields or process attributes within a form, an integration service or a workflow process. Individual fields or process attributes are accessed using their field/process attribute name. When the name is not a valid Java identifier e.g. it begins with a numeric, the element can only be accessed using the getField(String) method.

When running an event that forms part of a deployed component, only fields from the component can be accessed.

All included fields can be iterated using the following code:

 for ( var field in Iterator(fields.iterator()) )
 {
    log(field.elementName);
 }   
 

Examples:

 fields.FIELD1.value = "Test";
 fields.getField("2FIELD").value = 123;
 

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
Field	getField(java.lang.String fieldName) Returns the Field with name fieldName.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getField

Field getField(java.lang.String fieldName)

Returns the Field with name fieldName.

Since:

V4.4