info.magnolia.module.form.processors
Class AbstractFormProcessor

java.lang.Object
  info.magnolia.module.form.processors.AbstractFormProcessor

All Implemented Interfaces:

FormProcessor

Direct Known Subclasses:

AbstractEMailFormProcessor

public abstract class AbstractFormProcessor
extends Object
implements FormProcessor

Abstract base class for FormProcessors that want support for enabling/disabling.

Constructor Summary

AbstractFormProcessor()

Method Summary

String	getName()
protected abstract void	internalProcess(javax.jcr.Node content, Map<String,Object> parameters)
boolean	isEnabled()
void	process(javax.jcr.Node content, Map<String,Object> parameters) Performs an action when a form is submitted and validates successfully.
void	setEnabled(boolean enabled)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormProcessor

public AbstractFormProcessor()

Method Detail

getName

public String getName()

setName

public void setName(String name)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

process

public final void process(javax.jcr.Node content,
                          Map<String,Object> parameters)
                   throws FormProcessorFailedException

Description copied from interface: FormProcessor

Performs an action when a form is submitted and validates successfully. When encountering errors the FormProcessor can throw FormProcessorFailedException with a messages suitable to be displayed to the user. If it throws a runtime exception it is logged and a generic error message is displayed to the user.

Specified by:

process in interface FormProcessor

Parameters:

content - the node used to configure the processor, this is where it can find its settings

parameters - a map of the parameters collected from the form

Throws:

FormProcessorFailedException - when an error occurs and the FormProcessor has a message that is suitable error message for the user

internalProcess

protected abstract void internalProcess(javax.jcr.Node content,
                                        Map<String,Object> parameters)
                                 throws FormProcessorFailedException

Throws:

FormProcessorFailedException