Package name.matthewgreet.strutscommons.form

Interface Form

All Known Subinterfaces:
FormattableForm
All Known Implementing Classes:
AbstractForm, AbstractFormattableForm, NullForm
public interface Form
Template defining class that receives form data for form driven Actions.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doValidate(ValidationAware2 validationAware, TextProvider textProvider)
    Validates and parses form data itself, such as required fields or date validation, writing any error or field messages to the ValidationAware message receiver.
    ManualParameterConversionResult
    manualParameterConvert(Map<String,FieldParsedParameterList> unprocessedParameters, ValidationAware2 validationAware, TextProvider textProvider)
    Sets, converts and validates form fields from unprocessed request parameters, writes any error messages, and returns the names of successfully processed parameters and unsuccessfully processed parameters.
    void
    resetFields()
    Sets all displayed fields to default values for data entry of a new record, which is usually an empty string.

  • Method Details

    • resetFields

      void resetFields()
      Sets all displayed fields to default values for data entry of a new record, which is usually an empty string.

    • doValidate

      void doValidate(ValidationAware2 validationAware, TextProvider textProvider)
      Validates and parses form data itself, such as required fields or date validation, writing any error or field messages to the ValidationAware message receiver. Any error message indicates a failure.
      Parameters:
      validationAware - Message receiver, or null if Action does not support it. However, if Action only supports ValidationAware, that will be used and warning messages will be downgraded to info messages.
      textProvider - Message name translator that generates localised text, or null if Action does not support it.

    • manualParameterConvert

      ManualParameterConversionResult manualParameterConvert(Map<String,FieldParsedParameterList> unprocessedParameters, ValidationAware2 validationAware, TextProvider textProvider)

      Sets, converts and validates form fields from unprocessed request parameters, writes any error messages, and returns the names of successfully processed parameters and unsuccessfully processed parameters. Where multiple request parameters have the same name, only the first is presented.

      Unprocessed parameters are those that haven't set a form field for a number of reasons.

      • No form field has the same name.
      • Form field is annotated with ManualParameterConversion.
      • Form field is a non-string array type.
      Parameters:
      validationAware - Message receiver, or null if Action does not support it. However, if Action only supports ValidationAware, that will be used and warning messages will be downgraded to info messages.
      textProvider - Message name translator that generates localised text, or null if Action does not support it.