de.innovationgate.wgpublisher.webtml.form

Class TMLForm

java.lang.Object

de.innovationgate.wgpublisher.webtml.utils.TMLForm

de.innovationgate.wgpublisher.webtml.form.TMLForm

All Implemented Interfaces:

Form

public class TMLForm
extends TMLForm
implements Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TMLForm.FileUploadInputStream
static class	TMLForm.FileUploadLimitExceededException
static class	TMLForm.FormParseInfo
static class	TMLForm.MultipartFormData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RELATION_NULLPLACE_HOLDER
static java.lang.String	SYSTEMFIELD_AJAXCALLID
static java.lang.String	SYSTEMFIELD_AJAXGRAYDIV
static java.lang.String	SYSTEMFIELD_AJAXMODE
static java.lang.String	SYSTEMFIELD_FORMACTION
static java.lang.String	SYSTEMFIELD_FORMINFO
static java.lang.String	SYSTEMFIELD_PARSEINFO
static java.lang.String	SYSTEMFIELD_PORTLETSTATES
static java.lang.String	VALIDATIONVAR_ENTEREDVALUE
static java.lang.String	VALIDATIONVAR_FIELDNAME
static java.lang.String	VALIDATIONVAR_PARSEDVALUE

Constructor Summary

Constructors

Constructor and Description
TMLForm(WGACore core, TMLForm.MultipartFormData formData) Constructor to read form from posted data
TMLForm(WGACore core, TMLFormInfo formInfo, TMLContext context) Constructor to create a new form

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(TMLUserProfile obj)
boolean	attach(de.innovationgate.webgate.api.WGDocument doc) Attaches all files stored on this form to a document
boolean	attach(de.innovationgate.webgate.api.WGDocument doc, java.lang.String altFileName)
void	attachimage(de.innovationgate.webgate.api.WGDocument doc, int size)
void	attachimage(de.innovationgate.webgate.api.WGDocument doc, java.lang.String fit2size, java.lang.String compression, java.lang.String width, java.lang.String height)
void	attachimage(de.innovationgate.webgate.api.WGDocument doc, java.lang.String altFileName, java.lang.String fit2size, java.lang.String compression, java.lang.String width, java.lang.String height)
long	attachmentsize(java.lang.String fieldname)
void	attachscaledimage(de.innovationgate.webgate.api.WGDocument doc, de.innovationgate.utils.ImageScaler scaler)
void	attachscaledimage(de.innovationgate.webgate.api.WGDocument doc, de.innovationgate.utils.ImageScaler scaler, java.lang.String targetFileName)
void	clearFiles()
void	clearmessages() Clears all validation messages on the form
boolean	conditionFailed(java.lang.String condition) checks if the given condition (globalFormValdation) failed used by tml:validate to decide to display the message or not
java.lang.Object	enteredvalue(java.lang.String fieldname) Returns the unprocessed value of a field like the user entered it
de.innovationgate.wgaservices.types.Form	exportServicesForm()
FormSource	fetchFormSource(TMLContext cx)
java.lang.Object	field(java.lang.String name) Returns the value of a field as a single value.
java.util.List	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	getEnteredOrParsedValues(java.lang.String fieldname) returns the valuelist for the given fieldname the valuelist contains the parsedvalue, if successfully parsed otherwise the valuelist contains the enteredvalue
java.util.List	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	getfilenames() Lists the names of files that have been uploaded to this form
long	getfilesize(java.lang.String name)
java.lang.String	getfiletext(java.lang.String name) Returns the text contents of an uploaded file
java.lang.String	getformaction()
java.lang.String	getformid() Returns the ID of the form
TMLFormInfo	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	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
java.lang.String	getmode() returns the formmode
java.lang.Object	getpasswordsalt()
TMLFormProcessContext	getprocesscontext() Provides a ProcessContext to store arbitrary data for the form process
java.lang.String	getprocessid()
java.lang.String	getsource() returns the sourcetype ('content', 'portlet', etc.) of the form
TMLContext	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
void	importForm(TMLForm form)
void	importServicesForm(de.innovationgate.wgaservices.types.Form form)
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	processrtf(java.lang.String fieldName)
void	pushFields(de.innovationgate.webgate.api.WGDocument doc)
boolean	pushFiles(de.innovationgate.webgate.api.WGDocument doc)
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
boolean	retainFiles(de.innovationgate.webgate.api.WGDocument doc)
void	setcreateddoc(de.innovationgate.webgate.api.WGDocument createdDoc)
void	setfield(java.lang.String name, java.lang.Object value) Sets the value of a field
void	setFormInfo(TMLFormInfo formInfo)
void	setmessage(java.lang.String fieldName, java.lang.String message) Adds a new validation message related to the specified input field
void	setWasValidatedInThisRequest(boolean wasValidatedInThisRequest)
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	storeindocument(de.innovationgate.webgate.api.WGDocument doc)
boolean	storeinhdb()
boolean	storeinhdb(java.lang.Object parameter)
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	storeinprofile(TMLUserProfile profile)
boolean	validate() Manually triggers the form validation
boolean	wasValidatedInThisRequest()
boolean	writecsv(java.lang.String destination, boolean includeHeaders)
boolean	writecsv(java.lang.String destination, boolean includeHeaders, java.lang.String delimiter)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATIONVAR_PARSEDVALUE

public static final java.lang.String VALIDATIONVAR_PARSEDVALUE

See Also:

Constant Field Values

VALIDATIONVAR_ENTEREDVALUE

public static final java.lang.String VALIDATIONVAR_ENTEREDVALUE

See Also:

Constant Field Values

VALIDATIONVAR_FIELDNAME

public static final java.lang.String VALIDATIONVAR_FIELDNAME

See Also:

Constant Field Values

RELATION_NULLPLACE_HOLDER

public static final java.lang.String RELATION_NULLPLACE_HOLDER

See Also:

Constant Field Values

SYSTEMFIELD_PARSEINFO

public static final java.lang.String SYSTEMFIELD_PARSEINFO

See Also:

Constant Field Values

SYSTEMFIELD_FORMINFO

public static final java.lang.String SYSTEMFIELD_FORMINFO

See Also:

Constant Field Values

SYSTEMFIELD_AJAXCALLID

public static final java.lang.String SYSTEMFIELD_AJAXCALLID

See Also:

Constant Field Values

SYSTEMFIELD_AJAXGRAYDIV

public static final java.lang.String SYSTEMFIELD_AJAXGRAYDIV

See Also:

Constant Field Values

SYSTEMFIELD_AJAXMODE

public static final java.lang.String SYSTEMFIELD_AJAXMODE

See Also:

Constant Field Values

SYSTEMFIELD_FORMACTION

public static final java.lang.String SYSTEMFIELD_FORMACTION

See Also:

Constant Field Values

SYSTEMFIELD_PORTLETSTATES

public static final java.lang.String SYSTEMFIELD_PORTLETSTATES

See Also:

Constant Field Values

Constructor Detail

TMLForm

public TMLForm(WGACore core,
       TMLFormInfo formInfo,
       TMLContext context)
        throws de.innovationgate.webgate.api.WGException

Constructor to create a new form

Parameters:

core - The WGA core

formInfo - Information about the form to create

context - Target context path for the form (if not already set on forminfo)

Throws:

de.innovationgate.webgate.api.WGException

TMLForm

public TMLForm(WGACore core,
       TMLForm.MultipartFormData formData)
        throws de.innovationgate.webgate.api.WGException,
               java.io.UnsupportedEncodingException

Constructor to read form from posted data

Parameters:

core - The WGACore object

formData - The posted data

Throws:

de.innovationgate.webgate.api.WGException

java.io.UnsupportedEncodingException

Method Detail

getcreateddoc

public de.innovationgate.webgate.api.WGDocument getcreateddoc()

Description copied from interface: Form

Retrieves the document that was created by a TMLForm store operation

Specified by:

getcreateddoc in interface Form

validate

public boolean validate()

Description copied from interface: Form

Manually triggers the form validation

Specified by:

validate in interface Form

Returns:

true if validation succeeded, false otherwise

getformid

public java.lang.String getformid()

Description copied from interface: Form

Returns the ID of the form

Specified by:

getformid in interface Form

getfieldnames

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

Description copied from interface: Form

Lists the names of the fields on this form

Specified by:

getfieldnames in interface Form

hasfield

public boolean hasfield(java.lang.String name)

Description copied from interface: Form

Tests if the form contains a field of the given name

Specified by:

hasfield in interface Form

Parameters:

name - Name of the field

field

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

Description copied from interface: Form

Returns the value of a field as a single value.

Specified by:

field in interface Form

Parameters:

name - Name of the field

setfield

public void setfield(java.lang.String name,
            java.lang.Object value)
              throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Sets the value of a field

Specified by:

setfield in interface Form

Parameters:

name - Name of the field

value - Value of the field

Throws:

de.innovationgate.webgate.api.WGException

appendtofield

public void appendtofield(java.lang.String name,
                 java.lang.Object value)
                   throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Appends a value to the value list of a field

Specified by:

appendtofield in interface Form

Parameters:

name - Name of the field

value - Value to append

Throws:

de.innovationgate.webgate.api.WGException

removefield

public void removefield(java.lang.String name)

Description copied from interface: Form

Removes a field from the form and its data

Specified by:

removefield in interface Form

Parameters:

name - Name of the field

fieldlist

public java.util.List fieldlist(java.lang.String name)

Description copied from interface: Form

Returns the value of a field as a list value.

Specified by:

fieldlist in interface Form

Parameters:

name - Name of the field

parsedvalue

public java.lang.Object parsedvalue(java.lang.String fieldname)

Description copied from interface: Form

Returns the processed value of the field in its target type

Specified by:

parsedvalue in interface Form

Parameters:

fieldname - Name of the field

enteredvalue

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

Description copied from interface: Form

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

Specified by:

enteredvalue in interface Form

Parameters:

fieldname - The field name

getEnteredOrParsedValues

public java.util.List getEnteredOrParsedValues(java.lang.String fieldname)

returns the valuelist for the given fieldname the valuelist contains the parsedvalue, if successfully parsed otherwise the valuelist contains the enteredvalue

Parameters:

fieldname -

Returns:

storeinprofile

public boolean storeinprofile(TMLUserProfile profile)
                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

storeinprofile

public boolean storeinprofile()
                       throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Stores the form data on the users personalisation profile

Specified by:

storeinprofile in interface Form

Returns:

true if validation succeeded, false if not

Throws:

de.innovationgate.webgate.api.WGException

storeindocument

public boolean storeindocument(de.innovationgate.webgate.api.WGDocument doc)
                        throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

pushFields

public void pushFields(de.innovationgate.webgate.api.WGDocument doc)
                throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

storefield

public void storefield(java.lang.String fieldName,
              de.innovationgate.webgate.api.WGDocument doc)
                throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Form

Stores a single form field to a document. Uses the field name as item name.

Specified by:

storefield in interface Form

Parameters:

fieldName - The name of the field

doc - The document to store the field to

Throws:

de.innovationgate.webgate.api.WGAPIException

storefield

public void storefield(java.lang.String fieldName,
              de.innovationgate.webgate.api.WGDocument doc,
              java.lang.String targetName)
                throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Form

Stores a single form field to a document

Specified by:

storefield in interface Form

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

processrtf

public void processrtf(java.lang.String fieldName)
                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

storeincontent

public boolean storeincontent(de.innovationgate.webgate.api.WGContent content)
                       throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Stores the fields of the form to a content document

Specified by:

storeincontent in interface Form

Parameters:

content - The document to store the fields to

Returns:

true if validation succeeded, false if not

Throws:

de.innovationgate.webgate.api.WGException

storeinhdb

public boolean storeinhdb()
                   throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

storeinhdb

public boolean storeinhdb(java.lang.Object parameter)
                   throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

storeincontent

public boolean storeincontent()
                       throws de.innovationgate.webgate.api.WGException,
                              java.io.IOException

Description copied from interface: Form

Stores the fields of the form to the content document on the forms target context

Specified by:

storeincontent in interface Form

Returns:

true if validation succeeded, false if not

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

gettargetcontext

public TMLContext gettargetcontext()

Description copied from interface: Form

Returns the context for which this form was instantiated. This may influence the data source of the form.

Specified by:

gettargetcontext in interface Form

storeinportlet

public boolean storeinportlet(Portlet portlet)
                       throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Stores the form data into the a portlet configuration

Specified by:

storeinportlet in interface Form

Parameters:

portlet - The portlet to store the configuration to

Returns:

true if validation succeeded, false if not

Throws:

de.innovationgate.webgate.api.WGException

storeinportlet

public boolean storeinportlet()
                       throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Stores the form data into the configuration of the current portlet of the WebTML environment

Specified by:

storeinportlet in interface Form

Returns:

true if validation succeeded, false if not

Throws:

de.innovationgate.webgate.api.WGException

writecsv

public boolean writecsv(java.lang.String destination,
               boolean includeHeaders,
               java.lang.String delimiter)

writecsv

public boolean writecsv(java.lang.String destination,
               boolean includeHeaders)

geterrors

public java.util.List geterrors()

Description copied from interface: Form

Lists data type conversion errors

Specified by:

geterrors in interface Form

getfilenames

public java.util.List getfilenames()

Description copied from interface: Form

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

Specified by:

getfilenames in interface Form

getfile

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

Description copied from interface: Form

Returns a Java file object for an uploaded file

Specified by:

getfile in interface Form

Parameters:

name - Name of the file

Throws:

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

getfilesize

public long getfilesize(java.lang.String name)
                 throws java.io.IOException

Throws:

java.io.IOException

getfiletext

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

Description copied from interface: Form

Returns the text contents of an uploaded file

Specified by:

getfiletext in interface Form

Parameters:

name - Name of the file

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

attach

public boolean attach(TMLUserProfile obj)
               throws java.io.IOException,
                      de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

attach

public boolean attach(de.innovationgate.webgate.api.WGDocument doc,
             java.lang.String altFileName)
               throws java.io.IOException,
                      de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

pushFiles

public boolean pushFiles(de.innovationgate.webgate.api.WGDocument doc)
                  throws de.innovationgate.webgate.api.WGAPIException,
                         java.io.IOException

Throws:

de.innovationgate.webgate.api.WGAPIException

java.io.IOException

retainFiles

public boolean retainFiles(de.innovationgate.webgate.api.WGDocument doc)
                    throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

attach

public boolean attach(de.innovationgate.webgate.api.WGDocument doc)
               throws java.io.IOException,
                      de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Form

Attaches all files stored on this form to a document

Specified by:

attach in interface Form

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

attachmentsize

public long attachmentsize(java.lang.String fieldname)
                    throws java.io.IOException

Throws:

java.io.IOException

attachimage

public void attachimage(de.innovationgate.webgate.api.WGDocument doc,
               int size)

attachimage

public void attachimage(de.innovationgate.webgate.api.WGDocument doc,
               java.lang.String fit2size,
               java.lang.String compression,
               java.lang.String width,
               java.lang.String height)

attachscaledimage

public void attachscaledimage(de.innovationgate.webgate.api.WGDocument doc,
                     de.innovationgate.utils.ImageScaler scaler,
                     java.lang.String targetFileName)
                       throws java.io.IOException,
                              de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

attachscaledimage

public void attachscaledimage(de.innovationgate.webgate.api.WGDocument doc,
                     de.innovationgate.utils.ImageScaler scaler)
                       throws java.io.IOException,
                              de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

attachimage

public void attachimage(de.innovationgate.webgate.api.WGDocument doc,
               java.lang.String altFileName,
               java.lang.String fit2size,
               java.lang.String compression,
               java.lang.String width,
               java.lang.String height)

getformaction

public java.lang.String getformaction()

Returns:

importForm

public void importForm(TMLForm form)
                throws de.innovationgate.webgate.api.WGAPIException

Parameters:

form -

Throws:

de.innovationgate.webgate.api.WGAPIException

reset

public void reset()
           throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Form

Clears all fields and uploaded files from the form, resetting it completely

Specified by:

reset in interface Form

Throws:

de.innovationgate.webgate.api.WGAPIException

remove

public void remove()

Description copied from interface: Form

Removes the current form from form registry

Specified by:

remove in interface Form

iseditable

public boolean iseditable()

Description copied from interface: Form

Returns if this form is currently in edit mode

Specified by:

iseditable in interface Form

ispersistent

public boolean ispersistent()

Description copied from interface: Form

Shows if the form is persistent

Specified by:

ispersistent in interface Form

getmessages

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

Description copied from interface: Form

Lists all current validation messages

Specified by:

getmessages in interface Form

Parameters:

persistent - The persistent to set.

getglobalmessages

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

Description copied from interface: Form

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

Specified by:

getglobalmessages in interface Form

getmessage

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

Description copied from interface: Form

Returns the validation message of a field with failed validation

Specified by:

getmessage in interface Form

Parameters:

field - Name of the field

hasmessages

public boolean hasmessages()

Description copied from interface: Form

Tests if any validation messages exist

Specified by:

hasmessages in interface Form

hasmessage

public boolean hasmessage(java.lang.String field)

Description copied from interface: Form

Tests if a field specific validation message exists for the given field

Specified by:

hasmessage in interface Form

Parameters:

field - Name of the field

addmessage

public void addmessage(java.lang.String message)

Description copied from interface: Form

Adds a new global validation message

Specified by:

addmessage in interface Form

Parameters:

message - The message

setmessage

public void setmessage(java.lang.String fieldName,
              java.lang.String message)

Description copied from interface: Form

Adds a new validation message related to the specified input field

Specified by:

setmessage in interface Form

Parameters:

fieldName - The field for which the message is determined

message - The validation error message

conditionFailed

public boolean conditionFailed(java.lang.String condition)

checks if the given condition (globalFormValdation) failed used by tml:validate to decide to display the message or not

Parameters:

condition -

Returns:

getforminfo

public TMLFormInfo getforminfo()

Description copied from interface: Form

Grants access to the FormInfo object of this WebTML form

Specified by:

getforminfo in interface Form

setFormInfo

public void setFormInfo(TMLFormInfo formInfo)

clearmessages

public void clearmessages()

Description copied from interface: Form

Clears all validation messages on the form

Specified by:

clearmessages in interface Form

getinvalidfields

public java.util.List getinvalidfields()

Description copied from interface: Form

Lists names of fields with validation errors

Specified by:

getinvalidfields in interface Form

getsource

public java.lang.String getsource()

returns the sourcetype ('content', 'portlet', etc.) of the form

Returns:

source

public java.lang.String source()

Description copied from interface: Form

Returns the source type of the form

Specified by:

source in interface Form

getmode

public java.lang.String getmode()

returns the formmode

Returns:

'edit', 'view', 'readonly'

mode

public java.lang.String mode()

Description copied from interface: Form

Returns the display mode of the WebTML form

Specified by:

mode in interface Form

wasValidatedInThisRequest

public boolean wasValidatedInThisRequest()

setWasValidatedInThisRequest

public void setWasValidatedInThisRequest(boolean wasValidatedInThisRequest)

importServicesForm

public void importServicesForm(de.innovationgate.wgaservices.types.Form form)
                        throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

exportServicesForm

public de.innovationgate.wgaservices.types.Form exportServicesForm()
                                                            throws java.io.IOException,
                                                                   de.innovationgate.webgate.api.WGAPIException

Throws:

java.io.IOException

de.innovationgate.webgate.api.WGAPIException

issubmitted

public boolean issubmitted()

Description copied from interface: Form

Shows if the form was submitted from a previous request

Specified by:

issubmitted in interface Form

removefile

public boolean removefile(java.lang.String filename)

Description copied from interface: Form

Removes a file from the form

Specified by:

removefile in interface Form

Parameters:

filename - Name of the file

Returns:

true, if a file was removed, false if no file of the given name was found

addfile

public void addfile(java.io.File source,
           java.lang.String fileName)
             throws java.io.IOException,
                    java.security.NoSuchAlgorithmException

Description copied from interface: Form

Adds a file from the servers file system to the form

Specified by:

addfile in interface 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

public void addfile(java.io.File source)
             throws java.io.IOException,
                    java.security.NoSuchAlgorithmException

Description copied from interface: Form

Adds a file from the servers file system to the form

Specified by:

addfile in interface Form

Parameters:

source - The file

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

addfile

public void addfile(java.io.InputStream stream,
           java.lang.String fileName)
             throws java.io.IOException,
                    java.security.NoSuchAlgorithmException

Description copied from interface: Form

Adds a file from the servers file system to the form

Specified by:

addfile in interface 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

getprocessid

public java.lang.String getprocessid()

getprocesscontext

public TMLFormProcessContext getprocesscontext()

Description copied from interface: Form

Provides a ProcessContext to store arbitrary data for the form process

Specified by:

getprocesscontext in interface Form

isempty

public boolean isempty(java.lang.String fieldName)

Description copied from interface: Form

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.

Specified by:

isempty in interface Form

Parameters:

fieldName - Then name of the field

clearFiles

public void clearFiles()

isfilesdropped

public boolean isfilesdropped()

Description copied from interface: Form

Indicates if an uploaded file has been dropped because of its size

Specified by:

isfilesdropped in interface Form

fileurl

public java.lang.String fileurl(java.lang.String fileName)
                         throws org.apache.commons.httpclient.URIException

Description copied from interface: Form

Returns a URL to the uploaded file of the given name

Specified by:

fileurl in interface Form

Parameters:

fileName - Name of the file

Throws:

org.apache.commons.httpclient.URIException

setcreateddoc

public void setcreateddoc(de.innovationgate.webgate.api.WGDocument createdDoc)

store

public boolean store()
              throws de.innovationgate.webgate.api.WGException

Description copied from interface: Form

Stores the form data to the source of the form

Specified by:

store in interface Form

Returns:

true if the store operation succeeded, false if it didn't because of failed validations

Throws:

de.innovationgate.webgate.api.WGException

fetchFormSource

public FormSource fetchFormSource(TMLContext cx)
                           throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getpasswordsalt

public java.lang.Object getpasswordsalt()