View Javadoc

1   /*
2    * Copyright 2004-2009 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  package org.seasar.cubby.validator;
17  
18  import java.util.Map;
19  
20  import org.seasar.cubby.action.ActionErrors;
21  
22  /**
23   * 入力検証のルールです。
24   * 
25   * @author baba
26   */
27  public interface ValidationRule {
28  
29  	/**
30  	 * 要求パラメータにこの入力検証ルールを適用します。
31  	 * <p>
32  	 * 入力検証エラーの場合は指定された{@link ActionErrors}にメッセージを設定します。
33  	 * </p>
34  	 * 
35  	 * @param params
36  	 *            要求パラメータの{@link Map}
37  	 * @param form
38  	 *            フォームオブジェクト
39  	 * @param errors
40  	 *            アクションで発生したエラー
41  	 * @throws ValidationException
42  	 *             入力検証でエラーを検出し、検証を途中で中断する場合にスローされます
43  	 */
44  	void apply(Map<String, Object[]> params, Object form, ActionErrors errors)
45  			throws ValidationException;
46  
47  }