nl.gx.webmanager.handler.forms
Interface SessionFormElement

public interface SessionFormElement

This interface represents formvalues submitted for a formelement by a client.

Method Summary

void	addError(java.lang.String errorMessage) Adds an error to this instance.
void	addError(java.lang.String errorMessage, java.lang.String code) Adds an error to this instance.
void	addFormPart(SessionFormPart part) Adds a formpart for this form element.
void	clearAllErrors() Clears all errors for this element and all underlying formparts.
java.lang.String	getFormElementId() Returns the id of the formelement for which this instances holds the submitted values.
java.lang.String	getFormId()
SessionFormPart	getFormPart(java.lang.String formpartCode) Retrieves a session formpart with the specified formpart code.
java.util.List	getFormParts()
java.lang.String	getPageId()
void	setFormParts(SessionFormPart[] formParts) (Re) set the list of session formparts for this form element.

Method Detail

getFormElementId

java.lang.String getFormElementId()

Returns the id of the formelement for which this instances holds the submitted values.

Returns:

The id of the formelement.

setFormParts

void setFormParts(SessionFormPart[] formParts)

(Re) set the list of session formparts for this form element.

Parameters:

formParts - The new list of session formparts.

clearAllErrors

void clearAllErrors()

Clears all errors for this element and all underlying formparts.

addError

void addError(java.lang.String errorMessage)

Adds an error to this instance.

Parameters:

errorMessage - The error message that should be added

addError

void addError(java.lang.String errorMessage,
              java.lang.String code)

Adds an error to this instance.

Parameters:

errorMessage - The error message that should be added.

code - The code for the error message.

addFormPart

void addFormPart(SessionFormPart part)

Adds a formpart for this form element.

Parameters:

part - The session formpart that should be added

getFormPart

SessionFormPart getFormPart(java.lang.String formpartCode)

Retrieves a session formpart with the specified formpart code.

Parameters:

formpartCode - The code of the part that should be retrieved.

Returns:

The session formpart with the specified formpart code, or null if such a session formpart could not be retrieved.

getFormParts

java.util.List getFormParts()

Returns:

Returns the formParts.

getFormId

java.lang.String getFormId()

Returns:

Returns the formId.

getPageId

java.lang.String getPageId()

Returns:

Returns the pageId.