001// Copyright 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.form;
016
017import java.util.Locale;
018
019/**
020 * Support interface used to provide access to validation messages. Typically used by
021 * {@link org.apache.tapestry.form.validator.Validator}s.
022 * 
023 * @author Howard Lewis Ship
024 * @since 4.0
025 */
026public interface ValidationMessages
027{
028    /**
029     * Formats a validation message. Automatically chooses the correct localization.
030     * 
031     * @param messageOverride
032     *            a supplied override to the default message format taken from the
033     *            ValidationStrings.properties message catalog.
034     * @param messageKey
035     *            used to look up pa message format when messageOverride is blank (null or empty)
036     * @param arguments
037     *            array of arguments formatted with the message format
038     */
039
040    public String formatValidationMessage(String messageOverride, String messageKey,
041            Object[] arguments);
042
043    /**
044     * Returns the locale for which messages are generated.
045     */
046
047    public Locale getLocale();
048}