KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > form > ValidationMessages


1 // Copyright 2005 The Apache Software Foundation
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14

15 package org.apache.tapestry.form;
16
17 /**
18  * Support interface used to provide access to validation messages. Typically used by
19  * {@link org.apache.tapestry.form.validator.Validator}s.
20  *
21  * @author Howard Lewis Ship
22  * @since 4.0
23  */

24 public interface ValidationMessages
25 {
26     /**
27      * Formats a validation message. Automatically chooses the correct localization.
28      *
29      * @param messageOverride
30      * a supplied override to the default message format taken from the
31      * ValidationStrings.properties message catalog.
32      * @param messageKey
33      * used to look up pa message format when messageOverride is blank (null or empty)
34      * @param arguments
35      * array of arguments formatted with the message format
36      */

37
38     public String JavaDoc formatValidationMessage(String JavaDoc messageOverride, String JavaDoc messageKey,
39             Object JavaDoc[] arguments);
40 }
41
Popular Tags