Interface ValidationAware

All Known Subinterfaces:
ValidatorContext
All Known Implementing Classes:
ActionSupport, CspReportAction, DefaultActionSupport, DefaultCspReportAction, DelegatingValidatorContext, ValidationAwareSupport, VisitorFieldValidator.AppendingValidatorContext

public interface ValidationAware
ValidationAware classes can accept Action (class level) or field level error messages. Action level messages are kept in a Collection. Field level error messages are kept in a Map from String field name to a List of field error msgs.
  • Method Details

    • setActionErrors

      void setActionErrors(Collection<String> errorMessages)
      Set the Collection of Action-level String error messages.
      Parameters:
      errorMessages - Collection of String error messages
    • getActionErrors

      Collection<String> getActionErrors()
      Get the Collection of Action-level error messages for this action. Error messages should not be added directly here, as implementations are free to return a new Collection or an Unmodifiable Collection.
      Returns:
      Collection of String error messages
    • setActionMessages

      void setActionMessages(Collection<String> messages)
      Set the Collection of Action-level String messages (not errors).
      Parameters:
      messages - Collection of String messages (not errors).
    • getActionMessages

      Collection<String> getActionMessages()
      Get the Collection of Action-level messages for this action. Messages should not be added directly here, as implementations are free to return a new Collection or an Unmodifiable Collection.
      Returns:
      Collection of String messages
    • setFieldErrors

      void setFieldErrors(Map<String,List<String>> errorMap)
      Set the field error map of fieldname (String) to Collection of String error messages.
      Parameters:
      errorMap - field error map
    • getFieldErrors

      Map<String,List<String>> getFieldErrors()
      Get the field specific errors associated with this action. Error messages should not be added directly here, as implementations are free to return a new Collection or an Unmodifiable Collection.
      Returns:
      Map with errors mapped from fieldname (String) to Collection of String error messages
    • addActionError

      void addActionError(String anErrorMessage)
      Add an Action-level error message to this Action.
      Parameters:
      anErrorMessage - the error message
    • addActionMessage

      void addActionMessage(String aMessage)
      Add an Action-level message to this Action.
      Parameters:
      aMessage - the message
    • addFieldError

      void addFieldError(String fieldName, String errorMessage)
      Add an error message for a given field.
      Parameters:
      fieldName - name of field
      errorMessage - the error message
    • hasActionErrors

      boolean hasActionErrors()
      Check whether there are any Action-level error messages.
      Returns:
      true if any Action-level error messages have been registered
    • hasActionMessages

      boolean hasActionMessages()
      Checks whether there are any Action-level messages.
      Returns:
      true if any Action-level messages have been registered
    • hasErrors

      default boolean hasErrors()
      Checks whether there are any action errors or field errors.
      Returns:
      (hasActionErrors() || hasFieldErrors())
    • hasFieldErrors

      boolean hasFieldErrors()
      Check whether there are any field errors associated with this action.
      Returns:
      whether there are any field errors