Form (OpenWGA 7.1 Server API)

```
public interface Form
```
Represents a WebTML Form, containing form fields ans uploaded files This object is the same as the TMLForm object in TMLScript. Documentation on this object and its methods in more detail can therefor be found on the TMLScript reference of the OpenWGA documenation library of the respective OpenWGA version for Object "TMLForm".

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addfile(File source)` Adds a file from the servers file system to the form
`void`	`addfile(File source, String fileName)` Adds a file from the servers file system to the form
`void`	`addfile(InputStream stream, String fileName)` Adds a file from the servers file system to the form
`void`	`addmessage(String message)` Adds a new global validation message
`void`	`appendtofield(String name, Object value)` Appends a value to the value list of a field
`boolean`	`attach(de.innovationgate.webgate.api.WGDocument doc)` Attaches all files stored on this form to a document
`void`	`clearmessages()` Clears all validation messages on the form
`Object`	`enteredvalue(String fieldname)` Returns the unprocessed value of a field like the user entered it
`Object`	`field(String name)` Returns the value of a field as a single value.
`List<Object>`	`fieldlist(String name)` Returns the value of a field as a list value.
`String`	`fileurl(String fileName)` Returns a URL to the uploaded file of the given name
`de.innovationgate.webgate.api.WGDocument`	`getcreateddoc()` Retrieves the document that was created by a TMLForm store operation
`List<String>`	`geterrors()` Lists data type conversion errors
`List<String>`	`getfieldnames()` Lists the names of the fields on this form
`File`	`getfile(String name)` Returns a Java file object for an uploaded file
`List`	`getfilenames()` Lists the names of files that have been uploaded to this form
`String`	`getfiletext(String name)` Returns the text contents of an uploaded file
`String`	`getformid()` Returns the ID of the form
`FormInfo`	`getforminfo()` Grants access to the FormInfo object of this WebTML form
`List<String>`	`getglobalmessages()` Returns all validation messages that are global, i.e. not bound to a specific field
`List`	`getinvalidfields()` Lists names of fields with validation errors
`String`	`getmessage(String field)` Returns the validation message of a field with failed validation
`List<String>`	`getmessages()` Lists all current validation messages
`ProcessContext`	`getprocesscontext()` Provides a ProcessContext to store arbitrary data for the form process
`Context`	`gettargetcontext()` Returns the context for which this form was instantiated.
`boolean`	`hasfield(String name)` Tests if the form contains a field of the given name
`boolean`	`hasmessage(String field)` Tests if a field specific validation message exists for the given field
`boolean`	`hasmessages()` Tests if any validation messages exist
`boolean`	`iseditable()` Returns if this form is currently in edit mode
`boolean`	`isempty(String fieldName)` Returns if a field is empty.
`boolean`	`isfilesdropped()` Indicates if an uploaded file has been dropped because of its size
`boolean`	`ispersistent()` Shows if the form is persistent
`boolean`	`issubmitted()` Shows if the form was submitted from a previous request
`String`	`mode()` Returns the display mode of the WebTML form
`Object`	`parsedvalue(String fieldname)` Returns the processed value of the field in its target type
`void`	`remove()` Removes the current form from form registry
`void`	`removefield(String name)` Removes a field from the form and its data
`boolean`	`removefile(String filename)` Removes a file from the form
`void`	`reset()` Clears all fields and uploaded files from the form, resetting it completely
`void`	`setfield(String name, Object value)` Sets the value of a field
`void`	`setmessage(String fieldName, String message)` Adds a new validation message related to the specified input field
`String`	`source()` Returns the source type of the form
`boolean`	`store()` Stores the form data to the source of the form
`void`	`storefield(String fieldName, de.innovationgate.webgate.api.WGDocument doc)` Stores a single form field to a document.
`void`	`storefield(String fieldName, de.innovationgate.webgate.api.WGDocument doc, String targetName)` Stores a single form field to a document
`boolean`	`storeincontent()` Stores the fields of the form to the content document on the forms target context
`boolean`	`storeincontent(de.innovationgate.webgate.api.WGContent content)` Stores the fields of the form to a content document
`boolean`	`storeinportlet()` Stores the form data into the configuration of the current portlet of the WebTML environment
`boolean`	`storeinportlet(Portlet portlet)` Stores the form data into the a portlet configuration
`boolean`	`storeinprofile()` Stores the form data on the users personalisation profile
`boolean`	`validate()` Manually triggers the form validation

- Method Detail
  - addfile
```
void addfile(File source)
      throws IOException,
             NoSuchAlgorithmException
```
    Adds a file from the servers file system to the form
    
    Parameters:
    
    source - The file
    
    Throws:
    
    IOException
    
    NoSuchAlgorithmException
  - addfile
```
void addfile(File source,
             String fileName)
      throws IOException,
             NoSuchAlgorithmException
```
    Adds a file from the servers file system to the form
    
    Parameters:
    
    source - The file whose data is attached
    
    fileName - The name under which the file should get attached
    
    Throws:
    
    IOException
    
    NoSuchAlgorithmException
  - addfile
```
void addfile(InputStream stream,
             String fileName)
      throws IOException,
             NoSuchAlgorithmException
```
    Adds a file from the servers file system to the form
    
    Parameters:
    
    stream - The input stream serving the files ata
    
    fileName - The name under which the file should get attached
    
    Throws:
    
    IOException
    
    NoSuchAlgorithmException
  - addmessage
```
void addmessage(String message)
```
    Adds a new global validation message
    
    Parameters:
    
    message - The message
  - appendtofield
```
void appendtofield(String name,
                   Object value)
            throws de.innovationgate.webgate.api.WGException
```
    Appends a value to the value list of a field
    
    Parameters:
    
    name - Name of the field
    
    value - Value to append
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - attach
```
boolean attach(de.innovationgate.webgate.api.WGDocument doc)
        throws IOException,
               de.innovationgate.webgate.api.WGAPIException
```
    Attaches all files stored on this form to a document
    
    Parameters:
    
    doc -
    
    Throws:
    
    IOException
    
    de.innovationgate.webgate.api.WGAPIException
  - clearmessages
```
void clearmessages()
```
    Clears all validation messages on the form
  - enteredvalue
```
Object enteredvalue(String fieldname)
```
    Returns the unprocessed value of a field like the user entered it
    
    Parameters:
    
    fieldname - The field name
  - field
```
Object field(String name)
```
    Returns the value of a field as a single value.
    
    Parameters:
    
    name - Name of the field
  - fieldlist
```
List<Object> fieldlist(String name)
```
    Returns the value of a field as a list value.
    
    Parameters:
    
    name - Name of the field
  - fileurl
```
String fileurl(String fileName)
        throws org.apache.commons.httpclient.URIException
```
    Returns a URL to the uploaded file of the given name
    
    Parameters:
    
    fileName - Name of the file
    
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getcreateddoc
```
de.innovationgate.webgate.api.WGDocument getcreateddoc()
```
    Retrieves the document that was created by a TMLForm store operation
  - geterrors
```
List<String> geterrors()
```
    Lists data type conversion errors
  - getfieldnames
```
List<String> getfieldnames()
```
    Lists the names of the fields on this form
  - getfile
```
File getfile(String name)
      throws de.innovationgate.webgate.api.WGAPIException,
             IOException
```
    Returns a Java file object for an uploaded file
    
    Parameters:
    
    name - Name of the file
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
    
    IOException
  - getfilenames
```
List getfilenames()
```
    Lists the names of files that have been uploaded to this form
  - getfiletext
```
String getfiletext(String name)
            throws IOException,
                   de.innovationgate.webgate.api.WGAPIException
```
    Returns the text contents of an uploaded file
    
    Parameters:
    
    name - Name of the file
    
    Throws:
    
    IOException
    
    de.innovationgate.webgate.api.WGAPIException
  - getformid
```
String getformid()
```
    Returns the ID of the form
  - getforminfo
```
FormInfo getforminfo()
```
    Grants access to the FormInfo object of this WebTML form
  - getglobalmessages
```
List<String> getglobalmessages()
```
    Returns all validation messages that are global, i.e. not bound to a specific field
  - getinvalidfields
```
List getinvalidfields()
```
    Lists names of fields with validation errors
  - getmessage
```
String getmessage(String field)
```
    Returns the validation message of a field with failed validation
    
    Parameters:
    
    field - Name of the field
  - getmessages
```
List<String> getmessages()
```
    Lists all current validation messages
  - getprocesscontext
```
ProcessContext getprocesscontext()
```
    Provides a ProcessContext to store arbitrary data for the form process
  - gettargetcontext
```
Context gettargetcontext()
```
    Returns the context for which this form was instantiated. This may influence the data source of the form.
  - hasfield
```
boolean hasfield(String name)
```
    Tests if the form contains a field of the given name
    
    Parameters:
    
    name - Name of the field
  - hasmessage
```
boolean hasmessage(String field)
```
    Tests if a field specific validation message exists for the given field
    
    Parameters:
    
    field - Name of the field
  - hasmessages
```
boolean hasmessages()
```
    Tests if any validation messages exist
  - iseditable
```
boolean iseditable()
```
    Returns if this form is currently in edit mode
  - isfilesdropped
```
boolean isfilesdropped()
```
    Indicates if an uploaded file has been dropped because of its size
  - ispersistent
```
boolean ispersistent()
```
    Shows if the form is persistent
  - issubmitted
```
boolean issubmitted()
```
    Shows if the form was submitted from a previous request
  - mode
```
String mode()
```
    Returns the display mode of the WebTML form
  - parsedvalue
```
Object parsedvalue(String fieldname)
```
    Returns the processed value of the field in its target type
    
    Parameters:
    
    fieldname - Name of the field
  - remove
```
void remove()
```
    Removes the current form from form registry
  - removefield
```
void removefield(String name)
```
    Removes a field from the form and its data
    
    Parameters:
    
    name - Name of the field
  - removefile
```
boolean removefile(String filename)
```
    Removes a file from the form
    
    Parameters:
    
    filename - Name of the file
    
    Returns:
    
    true, if a file was removed, false if no file of the given name was found
  - reset
```
void reset()
    throws de.innovationgate.webgate.api.WGAPIException
```
    Clears all fields and uploaded files from the form, resetting it completely
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
  - setfield
```
void setfield(String name,
              Object value)
       throws de.innovationgate.webgate.api.WGException
```
    Sets the value of a field
    
    Parameters:
    
    name - Name of the field
    
    value - Value of the field
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - setmessage
```
void setmessage(String fieldName,
                String message)
```
    Adds a new validation message related to the specified input field
    
    Parameters:
    
    fieldName - The field for which the message is determined
    
    message - The validation error message
  - source
```
String source()
```
    Returns the source type of the form
  - store
```
boolean store()
       throws de.innovationgate.webgate.api.WGException
```
    Stores the form data to the source of the form
    
    Returns:
    
    true if the store operation succeeded, false if it didn't because of failed validations
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - storefield
```
void storefield(String fieldName,
                de.innovationgate.webgate.api.WGDocument doc)
         throws de.innovationgate.webgate.api.WGAPIException
```
    Stores a single form field to a document. Uses the field name as item name.
    
    Parameters:
    
    fieldName - The name of the field
    
    doc - The document to store the field to
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
  - storefield
```
void storefield(String fieldName,
                de.innovationgate.webgate.api.WGDocument doc,
                String targetName)
         throws de.innovationgate.webgate.api.WGAPIException
```
    Stores a single form field to a document
    
    Parameters:
    
    fieldName - The name of the field
    
    doc - The document to store the field to
    
    targetName - The name of the item to store this field to.
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
  - storeincontent
```
boolean storeincontent()
                throws de.innovationgate.webgate.api.WGException,
                       IOException
```
    Stores the fields of the form to the content document on the forms target context
    
    Returns:
    
    true if validation succeeded, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    IOException
  - storeincontent
```
boolean storeincontent(de.innovationgate.webgate.api.WGContent content)
                throws de.innovationgate.webgate.api.WGException
```
    Stores the fields of the form to a content document
    
    Parameters:
    
    content - The document to store the fields to
    
    Returns:
    
    true if validation succeeded, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - storeinportlet
```
boolean storeinportlet()
                throws de.innovationgate.webgate.api.WGException
```
    Stores the form data into the configuration of the current portlet of the WebTML environment
    
    Returns:
    
    true if validation succeeded, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - storeinportlet
```
boolean storeinportlet(Portlet portlet)
                throws de.innovationgate.webgate.api.WGException
```
    Stores the form data into the a portlet configuration
    
    Parameters:
    
    portlet - The portlet to store the configuration to
    
    Returns:
    
    true if validation succeeded, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - storeinprofile
```
boolean storeinprofile()
                throws de.innovationgate.webgate.api.WGException
```
    Stores the form data on the users personalisation profile
    
    Returns:
    
    true if validation succeeded, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - validate
```
boolean validate()
```
    Manually triggers the form validation
    
    Returns:
    
    true if validation succeeded, false otherwise
  - isempty
```
boolean isempty(String fieldName)
```
    Returns if a field is empty. This method also respects the field registration and is able to detect empty relation fields, which is not reliably possible via a simple check for an empty field value.
    
    Parameters:
    
    fieldName - Then name of the field

Interface Form

Method Summary

Method Detail

addfile

addfile

addfile

addmessage

appendtofield

attach

clearmessages

enteredvalue

field

fieldlist

fileurl

getcreateddoc

geterrors

getfieldnames

getfile

getfilenames

getfiletext

getformid

getforminfo

getglobalmessages

getinvalidfields

getmessage

getmessages

getprocesscontext

gettargetcontext

hasfield

hasmessage

hasmessages

iseditable

isfilesdropped

ispersistent

issubmitted

mode

parsedvalue

remove

removefield

removefile

reset

setfield

setmessage

source

store

storefield

storefield

storeincontent

storeincontent

storeinportlet

storeinportlet

storeinprofile

validate

isempty