/*
 * Copyright (c) 2003, Morpho Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of the Morpho Project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package jp.morpho.webapp.servlet.http;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

/**
 * <P>
 * HttpServletRequest インタフェースを拡張して、HTTP サーブレット用の要求情報を提供します。
 * </P>
 * <P>
 * HttpActionRequest インタフェースには、要求を処理するために必要なアクションやステータスを取得するためのメソッドが定義されます。
 * </P>
 * @author Kenichi Fukuda
 */
public interface HttpActionRequest
	extends HttpServletRequest
{

	/**
	 * <P>
	 * 要求を処理するアクションの値を取得します。
	 * </P>
	 * @return 要求を処理するアクションの値
	 */
	public String getAction();

	/**
	 * <P>
	 * 要求を処理するアクションの値を設定します。
	 * </P>
	 * @param action 要求を処理するアクションの値
	 */
	public void setAction(String action);

	/**
	 * <P>
	 * 要求を処理するステータスの値を取得します。
	 * </P>
	 * @return 要求を処理するステータスの値
	 */
	public String getStatus();

	/**
	 * <P>
	 * 要求を処理するステータスの値を設定します。
	 * </P>
	 * @param status 要求を処理するステータスの値
	 */
	public void setStatus(String status);

	/**
	 * <P>
	 * この要求にパラメータを設定します。
	 * </P>
	 * @param map 要求パラメータ
	 */
	public void setParameterMap(Map map);

	/**
	 * <P>
	 * この要求にパラメータのマップがある場合に、そのパラメータのマップを要求から削除します。<br>
	 * </P>
	 */
	public void removeParameterMap();

}
