Package com.uc4.api

Class Form

java.lang.Object
com.uc4.api.Form
All Implemented Interfaces:
Iterable<IFormItem>
public class Form extends Object implements Iterable<IFormItem>
Form for interactive user input.

  • Constructor Details

    • Form

      public Form(Document result)
      Creates a Read Object from a Document.
      Parameters:
      result - DOM

  • Method Details

    • size

      public int size()
      Returns the number of controls in form.
      Returns:
      Number of controls

    • iterator

      public Iterator<IFormItem> iterator()
      Returns a java.util.Iterator to get all FormItem in this form.
      Specified by:
      iterator in interface Iterable<IFormItem>
      Returns:
      Iterator

    • getFormTitle

      public String getFormTitle()
      Returns the title of this form.
      Returns:
      form title

    • getAcv

      public 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 String getIdnr()
      Returns the ID of the Request.
      Returns:
      ID