Package org.kuali.rice.krad.datadictionary.validation.constraint

Class DatePatternConstraint

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.validation.constraint.BaseConstraint

org.kuali.rice.krad.datadictionary.validation.constraint.ValidCharactersConstraint

org.kuali.rice.krad.datadictionary.validation.constraint.ValidDataPatternConstraint

org.kuali.rice.krad.datadictionary.validation.constraint.DatePatternConstraint

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, Constraint

public class DatePatternConstraint
extends ValidDataPatternConstraint

DatePatternConstraint constrains a field to only allow dates which are part of the formats defined in the system. Constraining a field all these formats is often not appropriate for fields, and you may want to constrain the input to a subset of the allowed formats in the system. This can be done by setting the allowed formats to this subset (see BasicDatePatternConstraint bean for example)

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.datadictionary.validation.constraint.ValidCharactersConstraint

value

Fields inherited from class org.kuali.rice.krad.datadictionary.validation.constraint.BaseConstraint

applyClientSide, constraintStateOverrides, messageComponentCode, messageKey, messageNamespaceCode, states, validationMessageParams

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor	Description
DatePatternConstraint()

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedFormats()
protected String	getRegexString()	Returns a regex representing all the allowed formats in the system.
List<String>	getValidationMessageParams()	Parameters to be used in the string retrieved by this constraint's messageKey, ordered by number of the param
void	setAllowedFormats(List<String> allowedFormats)	Sets the alloweFormats for this constraint, this must be a subset of the system configured formats for a date - this list should be used for most fields where you are expecting a user to enter a date in a specific format

Methods inherited from class org.kuali.rice.krad.datadictionary.validation.constraint.ValidDataPatternConstraint

getValue, setValue

Methods inherited from class org.kuali.rice.krad.datadictionary.validation.constraint.ValidCharactersConstraint

completeValidation

Methods inherited from class org.kuali.rice.krad.datadictionary.validation.constraint.BaseConstraint

getApplyClientSide, getConstraintStateOverrides, getMessageComponentCode, getMessageKey, getMessageNamespaceCode, getStates, getValidationMessageParamsArray, setApplyClientSide, setConstraintStateOverrides, setMessageComponentCode, setMessageKey, setMessageNamespaceCode, setStates, setValidationMessageParams

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Constructor Details

DatePatternConstraint

public DatePatternConstraint()

Method Details

getRegexString

protected String getRegexString()

Returns a regex representing all the allowed formats in the system. If allowedFormats is supplied, returns a regex representing only those formats.

Specified by:

getRegexString in class ValidDataPatternConstraint

Returns:

regular expression

See Also:

• ValidDataPatternConstraint.getRegexString()

getAllowedFormats

public List<String> getAllowedFormats()

Returns:

the allowedFormats

setAllowedFormats

public void setAllowedFormats(List<String> allowedFormats)

Sets the alloweFormats for this constraint, this must be a subset of the system configured formats for a date - this list should be used for most fields where you are expecting a user to enter a date in a specific format

Parameters:

allowedFormats - the allowedFormats to set

getValidationMessageParams

public List<String> getValidationMessageParams()

Description copied from class: BaseConstraint

Parameters to be used in the string retrieved by this constraint's messageKey, ordered by number of the param

Overrides:

getValidationMessageParams in class BaseConstraint

Returns:

the validationMessageParams