org.kuali.student.r2.common.datadictionary.dto
Class ValidCharactersConstraintInfo

java.lang.Object
  org.kuali.student.r2.common.datadictionary.dto.ValidCharactersConstraintInfo

All Implemented Interfaces:

Serializable, Constraint, BaseConstraintInfc, ValidCharactersConstraintInfc

public class ValidCharactersConstraintInfo
extends Object
implements ValidCharactersConstraintInfc, Serializable

See Also:

Serialized Form

Nested Class Summary

static class

ValidCharactersConstraintInfo.Builder

Constructor Summary

ValidCharactersConstraintInfo()
Constructs a new ValidCharactersConstraintInfo.

ValidCharactersConstraintInfo(ValidCharactersConstraintInfc vcc)
Constructs a new ValidCharactersConstraintInfo from a ValidCharactersConstraintInfc.

Method Summary

Boolean	getIsApplyClientSide() If this is true, the constraint should be applied on the client side when the user interacts with a field - if this constraint can be interpreted for client side use.
String	getJsValue() Javascript version of the regex defined in value.
String	getLabelKey() LabelKey should be a single word key.
String	getValue() The Java based regex for valid characters There are two forms: regex:xxxxx and just: xxxx If the 2nd form then it is interpreted as a simple list of valid characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidCharactersConstraintInfo

public ValidCharactersConstraintInfo()

Constructs a new ValidCharactersConstraintInfo.

ValidCharactersConstraintInfo

public ValidCharactersConstraintInfo(ValidCharactersConstraintInfc vcc)

Constructs a new ValidCharactersConstraintInfo from a ValidCharactersConstraintInfc.

Parameters:

vcc - the ValidcharactersConstraint to copy

Method Detail

getJsValue

public String getJsValue()

Description copied from interface: ValidCharactersConstraintInfc

Javascript version of the regex defined in value. This does not have to be set if this constraint's key maps to one of the default valid character methods contained in jQuery - (insert that list here). This must be set if there is NO default method that matches the label key and applyClientSide is true. This is completely ignored if applyClientSide is set to false.

Specified by:

getJsValue in interface ValidCharactersConstraintInfc

getValue

public String getValue()

Description copied from interface: ValidCharactersConstraintInfc

The Java based regex for valid characters There are two forms: regex:xxxxx and just: xxxx If the 2nd form then it is interpreted as a simple list of valid characters. Note: it is actualy converted to a regular expression by wrapping it in [].

Specified by:

getValue in interface ValidCharactersConstraintInfc

getIsApplyClientSide

public Boolean getIsApplyClientSide()

Description copied from interface: BaseConstraintInfc

If this is true, the constraint should be applied on the client side when the user interacts with a field - if this constraint can be interpreted for client side use. Default is true.

Specified by:

getIsApplyClientSide in interface BaseConstraintInfc

getLabelKey

public String getLabelKey()

Description copied from interface: BaseConstraintInfc

LabelKey should be a single word key. This key is used to find a message to use for this constraint from available messages. The key is also used for defining/retrieving validation method names when applicable - as such this key MUST exist for valid character constraints.

Specified by:

getLabelKey in interface BaseConstraintInfc