org.torweg.pulse.component.cms
Class CMSFormProcessorConfiguration

java.lang.Object
  org.torweg.pulse.configuration.Configuration
      org.torweg.pulse.component.cms.CMSFormProcessorConfiguration

All Implemented Interfaces:

java.io.Serializable

public class CMSFormProcessorConfiguration
extends Configuration

The Configuration of the CMSFormProcessor.

Version:

$Revision: 1914 $

Author:

Daniel Dietz

See Also:

Serialized Form

Nested Class Summary

static class	CMSFormProcessorConfiguration.Case A case of the CMSFormProcessorConfiguration.
static class	CMSFormProcessorConfiguration.Condition A check-Condition.

Constructor Summary

protected

CMSFormProcessorConfiguration() Deprecated.

Method Summary

CMSFormProcessorConfiguration.Case	getCase(java.lang.String caseName) Returns a CMSFormProcessorConfiguration.Case by given caseName.
java.util.List<? extends CMSFormProcessorConfiguration.Case>	getCases() Returns the cases.
java.util.Map<java.lang.String,java.lang.String>	getRegexFields(java.lang.String caseName) Returns the regex fields for the given case-name.
java.util.Collection<java.lang.String>	getRequiredFields(java.lang.String caseName) Returns the required fields for the given case-name.
java.lang.String	getSwitchParameter() Returns the switch-parameter.
ICMSFormProcessorTask	getTask(java.lang.String caseName) Returns the (configured) ICMSFormProcessorTask for the given case-name.
boolean	isRegexFieldUseStandardMessage(java.lang.String caseName, java.lang.String fieldName) Returns whether to use the standard error message for the regex field.
boolean	isRequireCaptcha(java.lang.String caseName) Returns the require-captcha for the given case-name.

Methods inherited from class org.torweg.pulse.configuration.Configuration

getBundle, isBundleConfiguration, isModified, setBundle, setConfigFile

Methods inherited from class java.lang.Object

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

Constructor Detail

CMSFormProcessorConfiguration

@Deprecated
protected CMSFormProcessorConfiguration()

Deprecated.

Default constructor.

Method Detail

getSwitchParameter

public final java.lang.String getSwitchParameter()

Returns the switch-parameter.

Returns:

the switch-parameter

getCases

public final java.util.List<? extends CMSFormProcessorConfiguration.Case> getCases()

Returns the cases.

Returns:

the cases

getCase

public final CMSFormProcessorConfiguration.Case getCase(java.lang.String caseName)

Returns a CMSFormProcessorConfiguration.Case by given caseName.

Parameters:

caseName - the caseName

Returns:

a CMSFormProcessorConfiguration.Case

getRequiredFields

public final java.util.Collection<java.lang.String> getRequiredFields(java.lang.String caseName)

Returns the required fields for the given case-name.

Parameters:

caseName - the case-name

Returns:

the required fields for the given case-name

getRegexFields

public final java.util.Map<java.lang.String,java.lang.String> getRegexFields(java.lang.String caseName)

Returns the regex fields for the given case-name.

Parameters:

caseName - the case-name

Returns:

the regex fields for the given case-name

isRegexFieldUseStandardMessage

public final boolean isRegexFieldUseStandardMessage(java.lang.String caseName,
                                                    java.lang.String fieldName)

Returns whether to use the standard error message for the regex field.

Parameters:

caseName - the case-name

fieldName - the field-name

Returns:

true if to use the standard error message for the regex field, false otherwise

isRequireCaptcha

public final boolean isRequireCaptcha(java.lang.String caseName)

Returns the require-captcha for the given case-name.

Parameters:

caseName - the case-name

Returns:

the require-captcha

getTask

public final ICMSFormProcessorTask getTask(java.lang.String caseName)

Returns the (configured) ICMSFormProcessorTask for the given case-name.

Parameters:

caseName - the case-name

Returns:

the ICMSFormProcessorTask