pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.component.cms
Class CMSFormProcessorConfiguration.Case

java.lang.Object
  extended by org.torweg.pulse.component.cms.CMSFormProcessorConfiguration.Case
All Implemented Interfaces:
java.io.Serializable, INamed
Enclosing class:
CMSFormProcessorConfiguration

public static class CMSFormProcessorConfiguration.Case
extends java.lang.Object
implements INamed, java.io.Serializable

A case of the CMSFormProcessorConfiguration.

Version:
$Revision: 1914 $
Author:
Daniel Dietz
See Also:
Serialized Form

Constructor Summary
protected CMSFormProcessorConfiguration.Case()
          Deprecated. 
 
Method Summary
 java.lang.String getName()
          Returns the name of the Case.
 java.util.Map<java.lang.String,java.lang.String> getRegexFields()
          Returns the regex fields.
 java.util.Collection<java.lang.String> getRequiredFields()
          Returns the required fields.
 java.lang.Class<? extends ICMSFormProcessorTask> getTask()
          Returns the class of ICMSFormProcessorTask of the CMSFormProcessorConfiguration.Case.
 java.lang.String getTaskFailureRedirectURI()
          Returns the URI to be used for redirects if the execution of the task has failed.
 java.lang.String getTaskSuccessRedirectURI()
          Returns the URI to be used for redirects if the task has been successfully executed.
 boolean isConditionFullFilled(java.lang.String fieldName, Command command, CMSFormProcessorConfiguration.Condition.CheckType ctype)
          Checks for the given field if there is a condition configured, and - if so - checks the given Command for the fulfilment of the condition.
 boolean isRegexFieldUseStandardMessage(java.lang.String n)
          Returns whether to use the standard error message for the regex field.
 boolean isRequireCaptcha()
          Returns the require-captcha.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMSFormProcessorConfiguration.Case

@Deprecated
protected CMSFormProcessorConfiguration.Case()
Deprecated. 

Default constructor.

Method Detail

getName

public final java.lang.String getName()
Returns the name of the Case.

Specified by:
getName in interface INamed
Returns:
the name

getTask

public final java.lang.Class<? extends ICMSFormProcessorTask> getTask()
Returns the class of ICMSFormProcessorTask of the CMSFormProcessorConfiguration.Case.

Returns:
the class of ICMSFormProcessorTask

getTaskSuccessRedirectURI

public final java.lang.String getTaskSuccessRedirectURI()
Returns the URI to be used for redirects if the task has been successfully executed.

Returns:
the taskSuccessRedirectURI

getTaskFailureRedirectURI

public final java.lang.String getTaskFailureRedirectURI()
Returns the URI to be used for redirects if the execution of the task has failed.

Returns:
the taskFailureRedirectURI

isRequireCaptcha

public final boolean isRequireCaptcha()
Returns the require-captcha.

Returns:
the require-captcha

getRegexFields

public final java.util.Map<java.lang.String,java.lang.String> getRegexFields()
Returns the regex fields.

Returns:
an unmodifiable view of the regex fields

isRegexFieldUseStandardMessage

public final boolean isRegexFieldUseStandardMessage(java.lang.String n)
Returns whether to use the standard error message for the regex field.

Parameters:
n - the name of the field
Returns:
true, if the standard message shall be used

getRequiredFields

public final java.util.Collection<java.lang.String> getRequiredFields()
Returns the required fields.

Returns:
an unmodifiable view of the required fields

isConditionFullFilled

public final boolean isConditionFullFilled(java.lang.String fieldName, Command command, CMSFormProcessorConfiguration.Condition.CheckType ctype)
Checks for the given field if there is a condition configured, and - if so - checks the given Command for the fulfilment of the condition.

Parameters:
fieldName - the name of the field
command - the current Command
ctype - the CheckType
Returns:
true if the condition is fulfilled and the check is to be performed