nl.gx.webmanager.handler.forms
Interface SessionFormFlow

public interface SessionFormFlow

This interface represents the values and files submitted by the client, filling out a flow of forms.

Method Summary

void	addGlobalXml(java.lang.String tagName, java.lang.String xmlContents) Adds xml to the global xml values.
FormEntry[]	getEntries(java.lang.String formpartCode) Returns the values and files that have been submitted by the client for the specified formpartcode, as the have been saved in the formflow session of the client.
java.lang.String	getFlowId() Returns the id of the definition of the formflow.
java.util.List	getFormElements()
java.lang.String[]	getFormNavigationUrls() Returns the array of urls visited by the user for the given flow.
java.lang.String[]	getFormpath() Returns the list of formelement ids visited by the client during the current session and flow.
java.lang.String	getParameter(java.lang.String formPartCode) Returns a single text values for the formpart code.
void	removeGlobalValues(java.lang.String tagName) Removes all global xml entries with the specified tagname.
void	setEntries(java.lang.String formElementId, java.lang.String formpartCode, java.lang.String[] values) Overwrites the values that have been submitted by the client for the specified formpartcode and saves these valies in the formflow session of the client.
void	setFormNavigation(java.lang.String[] formNavigationUrls) Updates the list of urls visited by the user for the given flow.
void	setFormpath(java.lang.String[] formPathElementIds) Updates the list of form element ids visited by the client during the current session and flow.
void	setGlobalValue(java.lang.String key, java.lang.String value) Sets the global value for key to the specified value.
java.lang.String	writeXml() Returns the xml representation of this object.

Method Detail

getParameter

java.lang.String getParameter(java.lang.String formPartCode)

Returns a single text values for the formpart code.

Parameters:

formPartCode - The formpart code for which the text value should be retrieved

Returns:

The first text value for the formpart, or null if no values could be found.

getEntries

FormEntry[] getEntries(java.lang.String formpartCode)

Returns the values and files that have been submitted by the client for the specified formpartcode, as the have been saved in the formflow session of the client.

Parameters:

formpartCode - The code of the formpart used in the actual html forms.

Returns:

The array of filled values or null if the values for the formpart code could not be found.

setEntries

void setEntries(java.lang.String formElementId,
                java.lang.String formpartCode,
                java.lang.String[] values)

Overwrites the values that have been submitted by the client for the specified formpartcode and saves these valies in the formflow session of the client.

Parameters:

formElementId - The id of the form, for which the new values should be stored.

formpartCode - The code of the formpart used in the actual html forms.

values - The new values for the formpart code in the formflow.

getFlowId

java.lang.String getFlowId()

Returns the id of the definition of the formflow.

Returns:

the id of the definition of the formflow.

getFormElements

java.util.List getFormElements()

removeGlobalValues

void removeGlobalValues(java.lang.String tagName)

Removes all global xml entries with the specified tagname.

Parameters:

tagName - The name of tags that should be removed from the global values.

addGlobalXml

void addGlobalXml(java.lang.String tagName,
                  java.lang.String xmlContents)

Adds xml to the global xml values.

Parameters:

tagName - The name of the root xml that will be added.

xmlContents - The total xml contents that should be added.

setGlobalValue

void setGlobalValue(java.lang.String key,
                    java.lang.String value)

Sets the global value for key to the specified value.

Parameters:

key - The key for global values.

value - The new value for the specified key.

getFormNavigationUrls

java.lang.String[] getFormNavigationUrls()

Returns the array of urls visited by the user for the given flow.

Returns:

The array of urls visited by the user for the given flow.

getFormpath

java.lang.String[] getFormpath()

Returns the list of formelement ids visited by the client during the current session and flow.

Returns:

the list of formelement ids visited by the client during the current session and flow.

setFormpath

void setFormpath(java.lang.String[] formPathElementIds)

Updates the list of form element ids visited by the client during the current session and flow.

Parameters:

formPathElementIds - The new list of form elementids.

setFormNavigation

void setFormNavigation(java.lang.String[] formNavigationUrls)

Updates the list of urls visited by the user for the given flow.

Parameters:

formNavigationUrls - The new list of visited urls.

writeXml

java.lang.String writeXml()

Returns the xml representation of this object.

Returns:

The xml representation of this object.