View Javadoc

1   /*
2    * Copyright 2004-2010 the Seasar Foundation and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  
17  package org.seasar.cubby.validator;
18  
19  import java.util.Map;
20  
21  import org.seasar.cubby.action.ActionErrors;
22  
23  /**
24   * 入力検証のルールです。
25   * 
26   * @author baba
27   */
28  public interface ValidationRule {
29  
30  	/**
31  	 * 要求パラメータにこの入力検証ルールを適用します。
32  	 * <p>
33  	 * 入力検証エラーの場合は指定された{@link ActionErrors}にメッセージを設定します。
34  	 * </p>
35  	 * 
36  	 * @param params
37  	 *            要求パラメータの{@link Map}
38  	 * @param form
39  	 *            フォームオブジェクト
40  	 * @param errors
41  	 *            アクションで発生したエラー
42  	 * @throws ValidationException
43  	 *             入力検証でエラーを検出し、検証を途中で中断する場合にスローされます
44  	 */
45  	void apply(Map<String, Object[]> params, Object form, ActionErrors errors)
46  			throws ValidationException;
47  
48  }