Package com.uc4.api
Class Form
java.lang.Object
com.uc4.api.Form
Form for interactive user input.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAcv()
Returns the address for the communication.Returns the title of this form.getIdnr()
Returns the ID of the Request.boolean
isSent()
Returns a flag to indicate if this form has been sent to the Automation Engine.iterator()
Returns ajava.util.Iterator
to get allFormItem
in this form.void
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 Details
-
Form
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
Returns ajava.util.Iterator
to get allFormItem
in this form. -
getFormTitle
Returns the title of this form.- Returns:
- form title
-
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
Returns the ID of the Request.- Returns:
- ID
-