de.innovationgate.wga.server.api.tml

Interface Form

All Known Implementing Classes:

TMLForm

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

Methods

Modifier and Type	Method and Description
void	addfile(java.io.File source) Adds a file from the servers file system to the form
void	addfile(java.io.File source, java.lang.String fileName) Adds a file from the servers file system to the form
void	addfile(java.io.InputStream stream, java.lang.String fileName) Adds a file from the servers file system to the form
void	addmessage(java.lang.String message) Adds a new global validation message
void	appendtofield(java.lang.String name, java.lang.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
java.lang.Object	enteredvalue(java.lang.String fieldname) Returns the unprocessed value of a field like the user entered it
java.lang.Object	field(java.lang.String name) Returns the value of a field as a single value.
java.util.List<java.lang.Object>	fieldlist(java.lang.String name) Returns the value of a field as a list value.
java.lang.String	fileurl(java.lang.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
java.util.List<java.lang.String>	geterrors() Lists data type conversion errors
java.util.List<java.lang.String>	getfieldnames() Lists the names of the fields on this form
java.io.File	getfile(java.lang.String name) Returns a Java file object for an uploaded file
java.util.List<java.lang.Object>	getfilenames() Lists the names of files that have been uploaded to this form
java.lang.String	getfiletext(java.lang.String name) Returns the text contents of an uploaded file
java.lang.String	getformid() Returns the ID of the form
FormInfo	getforminfo() Grants access to the FormInfo object of this WebTML form
java.util.List<java.lang.String>	getglobalmessages() Returns all validation messages that are global, i.e. not bound to a specific field
java.util.List<java.lang.Object>	getinvalidfields() Lists names of fields with validation errors
java.lang.String	getmessage(java.lang.String field) Returns the validation message of a field with failed validation
java.util.List<java.lang.String>	getmessages() Lists all current validation messages
TMLFormProcessContext	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(java.lang.String name) Tests if the form contains a field of the given name
boolean	hasmessage(java.lang.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(java.lang.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
java.lang.String	mode() Returns the display mode of the WebTML form
java.lang.Object	parsedvalue(java.lang.String fieldname) Returns the processed value of the field in its target type
void	remove() Removes the current form from form registry
void	removefield(java.lang.String name) Removes a field from the form and its data
boolean	removefile(java.lang.String filename) Removes a file from the form
void	reset() Clears all fields and uploaded files from the form, resetting it completely
void	setfield(java.lang.String name, java.lang.Object value) Sets the value of a field
void	setmessage(java.lang.String fieldName, java.lang.String message) Adds a new validation message related to the specified input field
java.lang.String	source() Returns the source type of the form
boolean	store() Stores the form data to the source of the form
void	storefield(java.lang.String fieldName, de.innovationgate.webgate.api.WGDocument doc) Stores a single form field to a document.
void	storefield(java.lang.String fieldName, de.innovationgate.webgate.api.WGDocument doc, java.lang.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(java.io.File source)
             throws java.io.IOException,
                    java.security.NoSuchAlgorithmException

Adds a file from the servers file system to the form

Parameters:

source - The file

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

addfile

void addfile(java.io.File source,
           java.lang.String fileName)
             throws java.io.IOException,
                    java.security.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:

java.io.IOException

java.security.NoSuchAlgorithmException

addfile

void addfile(java.io.InputStream stream,
           java.lang.String fileName)
             throws java.io.IOException,
                    java.security.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:

java.io.IOException

java.security.NoSuchAlgorithmException

addmessage

void addmessage(java.lang.String message)

Adds a new global validation message

Parameters:

message - The message

appendtofield

void appendtofield(java.lang.String name,
                 java.lang.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 java.io.IOException,
                      de.innovationgate.webgate.api.WGAPIException

Attaches all files stored on this form to a document

Parameters:

doc -

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

clearmessages

void clearmessages()

Clears all validation messages on the form

enteredvalue

java.lang.Object enteredvalue(java.lang.String fieldname)

Returns the unprocessed value of a field like the user entered it

Parameters:

fieldname - The field name

field

java.lang.Object field(java.lang.String name)

Returns the value of a field as a single value.

Parameters:

name - Name of the field

fieldlist

java.util.List<java.lang.Object> fieldlist(java.lang.String name)

Returns the value of a field as a list value.

Parameters:

name - Name of the field

fileurl

java.lang.String fileurl(java.lang.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

java.util.List<java.lang.String> geterrors()

Lists data type conversion errors

getfieldnames

java.util.List<java.lang.String> getfieldnames()

Lists the names of the fields on this form

getfile

java.io.File getfile(java.lang.String name)
                     throws de.innovationgate.webgate.api.WGAPIException,
                            java.io.IOException

Returns a Java file object for an uploaded file

Parameters:

name - Name of the file

Throws:

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

getfilenames

java.util.List<java.lang.Object> getfilenames()

Lists the names of files that have been uploaded to this form

getfiletext

java.lang.String getfiletext(java.lang.String name)
                             throws java.io.IOException,
                                    de.innovationgate.webgate.api.WGAPIException

Returns the text contents of an uploaded file

Parameters:

name - Name of the file

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

getformid

java.lang.String getformid()

Returns the ID of the form

getforminfo

FormInfo getforminfo()

Grants access to the FormInfo object of this WebTML form

getglobalmessages

java.util.List<java.lang.String> getglobalmessages()

Returns all validation messages that are global, i.e. not bound to a specific field

getinvalidfields

java.util.List<java.lang.Object> getinvalidfields()

Lists names of fields with validation errors

getmessage

java.lang.String getmessage(java.lang.String field)

Returns the validation message of a field with failed validation

Parameters:

field - Name of the field

getmessages

java.util.List<java.lang.String> getmessages()

Lists all current validation messages

getprocesscontext

TMLFormProcessContext 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(java.lang.String name)

Tests if the form contains a field of the given name

Parameters:

name - Name of the field

hasmessage

boolean hasmessage(java.lang.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

java.lang.String mode()

Returns the display mode of the WebTML form

parsedvalue

java.lang.Object parsedvalue(java.lang.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(java.lang.String name)

Removes a field from the form and its data

Parameters:

name - Name of the field

removefile

boolean removefile(java.lang.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(java.lang.String name,
            java.lang.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(java.lang.String fieldName,
              java.lang.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

java.lang.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(java.lang.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(java.lang.String fieldName,
              de.innovationgate.webgate.api.WGDocument doc,
              java.lang.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,
                              java.io.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

java.io.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(java.lang.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