de.innovationgate.wgpublisher.webtml.form

Interface FormSource

All Known Implementing Classes:

ContextDocumentFormSource, EmptyFormSource, PortletConfigFormSource, PortletSessionVarsFormSource, UserProfileFormSource

public interface FormSource

Source of data for WebTML forms. Implementations of this object are instantiated for concrete occasions where fields are read and forms are stored.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<?>	getFieldValue(java.lang.String fieldname, boolean meta, java.lang.Object defaultvalue, boolean useRelation, TMLFormInfo formInfo) Retrieve a field value from the form source for a form field
void	init(TMLContext context) Init method called before the source is used.
boolean	storeForm(TMLForm form, boolean includeFiles) Store the data of the given form to the form source backend.

Method Detail

init

void init(TMLContext context)
          throws de.innovationgate.webgate.api.WGException

Init method called before the source is used.

Parameters:

context - The WebTML target context of the WebTML form

Throws:

de.innovationgate.webgate.api.WGException

getFieldValue

java.util.List<?> getFieldValue(java.lang.String fieldname,
                              boolean meta,
                              java.lang.Object defaultvalue,
                              boolean useRelation,
                              TMLFormInfo formInfo)
                                throws de.innovationgate.webgate.api.WGException

Retrieve a field value from the form source for a form field

Parameters:

fieldname - The name of the field

meta - Whether the field is regarded a metadata field

defaultvalue - The default value to return if the field does not exist

useRelation - Whether the field is regarded to originate from a content relation

formInfo - The form info of the retrieving form with eventually necessary status information

Returns:

The field value as list. Form fields always store lists.

Throws:

de.innovationgate.webgate.api.WGException

storeForm

boolean storeForm(TMLForm form,
                boolean includeFiles)
                  throws de.innovationgate.webgate.api.WGException

Store the data of the given form to the form source backend. It is in the responsibility of this method to

• Generally store the fields according to the available form field registration, like respecting multvalue/non-multivalue fields
• Especially filter out fields whose field registration mark them as stored="false"

It is not in the responsibility of the form source to validate the form.

Parameters:

form - The form whose data to store

includeFiles - Whether files attached to the form should also be stored, if even possible

Returns:

Always true

Throws:

de.innovationgate.webgate.api.WGException