Form (java-api 24.3.0 API)

java.lang.Object
- com.uc4.api.Form

All Implemented Interfaces:

java.lang.Iterable<IFormItem>
```
public class Form
extends java.lang.Object
implements java.lang.Iterable<IFormItem>
```
Form for interactive user input.

Constructor Summary

Constructors
Constructor Description

Form(org.w3c.dom.Document result)
Creates a Read Object from a Document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAcv()`	Returns the address for the communication.
`java.lang.String`	`getFormTitle()`	Returns the title of this form.
`java.lang.String`	`getIdnr()`	Returns the ID of the Request.
`boolean`	`isSent()`	Returns a flag to indicate if this form has been sent to the Automation Engine.
`java.util.Iterator<IFormItem>`	`iterator()`	Returns a `java.util.Iterator` to get all `FormItem` in this form.
`void`	`setSentFlag()`	Called when this Form is submitted.
`int`	`size()`	Returns the number of controls in form.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Form
```
public Form(org.w3c.dom.Document result)
```
    Creates a Read Object from a Document.
    
    Parameters:
    
    result - DOM
- Method Detail
  - size
```
public int size()
```
    Returns the number of controls in form.
    
    Returns:
    
    Number of controls
  - iterator
```
public java.util.Iterator<IFormItem> iterator()
```
    Returns a java.util.Iterator to get all FormItem in this form.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<IFormItem>
    
    Returns:
    
    Iterator
  - getFormTitle
```
public java.lang.String getFormTitle()
```
    Returns the title of this form.
    
    Returns:
    
    form title
  - getAcv
```
public java.lang.String getAcv()
```
    Returns the address for the communication.
    
    Returns:
    
    address
  - isSent
```
public boolean isSent()
```
    Returns a flag to indicate if this form has been sent to the Automation Engine.
    
    Returns:
    
    Returns true if this form was already submitted; false if not.
  - setSentFlag
```
public void setSentFlag()
```
    Called when this Form is submitted.
  - getIdnr
```
public java.lang.String getIdnr()
```
    Returns the ID of the Request.
    
    Returns:
    
    ID