org.apache.beehive.netui.pageflow.annotations
Annotation Type Jpf.ValidatableProperty


@Target(value={ANNOTATION_TYPE,METHOD})
@Retention(value=RUNTIME)
public static @interface Jpf.ValidatableProperty

A set of validation rules that will be applied against a property. Used directly on a property getter method, or within a Jpf.Action, Jpf.SimpleAction, or Jpf.ValidatableBean annotation. Contains rules to be applied for every locale, and sets of locale-specific rules.


Optional Element Summary
 String displayName
          The JSP 2.0-style expression (e.g., ${bundle.default.someMessageResource}) or literal string that will be used as the first argument to all error messages for this property.
 String displayNameKey
          A key in the default message bundle or in the bundle specified by Jpf.MessageBundle.bundleName() that will be used as the first argument to all error messages for this property.
 Jpf.ValidationLocaleRules[] localeRules
          An array of sets of locale-specific validation rules.
 String propertyName
          The name of the property to run rules against.
 Jpf.ValidateCreditCard validateCreditCard
          A Jpf.ValidateCreditCard rule that will be applied for all locales.
 Jpf.ValidateCustomRule[] validateCustomRules
          A Jpf.ValidateCustomRule rule that will be applied for all locales.
 Jpf.ValidateDate validateDate
          A Jpf.ValidateDate rule that will be applied for all locales.
 Jpf.ValidateEmail validateEmail
          A Jpf.ValidateEmail rule that will be applied for all locales.
 Jpf.ValidateMask validateMask
          A Jpf.ValidateMask rule that will be applied for all locales.
 Jpf.ValidateMaxLength validateMaxLength
          A Jpf.ValidateMaxLength rule that will be applied for all locales.
 Jpf.ValidateMinLength validateMinLength
          A Jpf.ValidateMinLength rule that will be applied for all locales.
 Jpf.ValidateRange validateRange
          A Jpf.ValidateRange rule that will be applied for all locales.
 Jpf.ValidateRequired validateRequired
          A Jpf.ValidateRequired rule that will be applied for all locales.
 Jpf.ValidateType validateType
          A Jpf.ValidateType rule that will be applied for all locales.
 Jpf.ValidateURL validateURL
          A Jpf.ValidateURL rule that will be applied for all locales.
 Jpf.ValidateValidWhen validateValidWhen
          A Jpf.ValidateValidWhen rule that will be applied for all locales.
 

propertyName

public abstract String propertyName
The name of the property to run rules against. When this annotation is used on a property getter method, propertyName is illegal because the property name is inferred from the method name.

Default:
""

displayName

public abstract String displayName
The JSP 2.0-style expression (e.g., ${bundle.default.someMessageResource}) or literal string that will be used as the first argument to all error messages for this property. When this is specified, the individual rules can avoid providing specific messages; instead, a default message will be used. Mutually-exclusive with displayNameKey().

Default:
""

displayNameKey

public abstract String displayNameKey
A key in the default message bundle or in the bundle specified by Jpf.MessageBundle.bundleName() that will be used as the first argument to all error messages for this property. When this is specified, the individual rules can avoid providing specific messages; instead, a default message will be used. Mutually-exclusive with displayName().

See Also:
Jpf.MessageBundle
Default:
""

validateRequired

public abstract Jpf.ValidateRequired validateRequired
A Jpf.ValidateRequired rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateRequired(enabled=false)

validateMinLength

public abstract Jpf.ValidateMinLength validateMinLength
A Jpf.ValidateMinLength rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateMinLength(enabled=false, chars=-1)

validateMaxLength

public abstract Jpf.ValidateMaxLength validateMaxLength
A Jpf.ValidateMaxLength rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateMaxLength(enabled=false, chars=-1)

validateMask

public abstract Jpf.ValidateMask validateMask
A Jpf.ValidateMask rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateMask(enabled=false, regex="")

validateType

public abstract Jpf.ValidateType validateType
A Jpf.ValidateType rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateType(enabled=false, type=void.class)

validateDate

public abstract Jpf.ValidateDate validateDate
A Jpf.ValidateDate rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateDate(enabled=false, pattern="")

validateRange

public abstract Jpf.ValidateRange validateRange
A Jpf.ValidateRange rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateRange(enabled=false)

validateCreditCard

public abstract Jpf.ValidateCreditCard validateCreditCard
A Jpf.ValidateCreditCard rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateCreditCard(enabled=false)

validateEmail

public abstract Jpf.ValidateEmail validateEmail
A Jpf.ValidateEmail rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateEmail(enabled=false)

validateValidWhen

public abstract Jpf.ValidateValidWhen validateValidWhen
A Jpf.ValidateValidWhen rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateValidWhen(enabled=false, condition="")

validateURL

public abstract Jpf.ValidateURL validateURL
A Jpf.ValidateURL rule that will be applied for all locales.

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.ValidateURL(enabled=false)

validateCustomRules

public abstract Jpf.ValidateCustomRule[] validateCustomRules
A Jpf.ValidateCustomRule rule that will be applied for all locales.

Default:
{}

localeRules

public abstract Jpf.ValidationLocaleRules[] localeRules
An array of sets of locale-specific validation rules.

Default:
{}