// Copyright 2005-2007 onetsoft.com
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.onetsoft.fastjsp.request;

import java.util.Map;
import java.util.Set;

/**
 * 頁面請求數據
 * 注：為加快性能,對于一些特殊對象的可考慮直接作為IPage頁面類屬性
 *
 * @author <a href="mailto:hgw@onetsoft.com">hgw</a>
 */
public interface PageData {

    /**
     * 取得action
     *
     * @return
     * @since 3.1
     */
    String getAction();

    /**
     * 取得參數 Map
     *
     * @since 3.0
     */
    Map getMap();

    /**
     * 設置參數集
     * 注：只放入非 null 值
     *
     * @param map
     * @since 3.0
     */
    void put(Map map);

    /**
     * 獲取所有參數鍵
     *
     * @return
     * @since 3.0
     */
    Set keySet();

    /**
     * 保存頁面數據
     * 不允許放入null值
     *
     * @param name
     * @param value
     */
    void put(Object name, Object value);


    /**
     * 置入映射數據
     * 一般用于在表單初始化是初始表單域數據
     *
     * @param bean 攜帶數據的類
     * @since 1.2
     */
    void put(Object bean);

    /**
     * 取得頁面數據
     * 應注意區分是否為自行傳入的參數對象
     *
     * @param name
     * @return 參數不存在，返回 null
     */
    Object get(Object name);

    /**
     * 取得數據映射對象
     * 一般用于取得表單映射類數據
     * 注：映射類須有共構造函數
     *
     * @param beanClass 映射類
     * @return 返回填充了數據的映射類
     * @since 1.2
     */
    Object get(Class beanClass);


    /**
     * 清除數據
     *
     * @param name
     */
    void remove(Object name);

    /**
     * 清除所有數據
     */
    void clear();


    /**
     * 返回指定上載文件
     * 若無對應文件，則返回null
     */

    public  UploadFile getFileUpload(String parameterName);

    /**
     * 取得所有上載文件
     *
     * @return
     */
    public  UploadFile[] getFileUploads();


    /**
     * 取得request的多值參數
     *
     * @param name
     * @return
     */
    String[] getParameterValues(String name);


    /**
     * 取得字符串
     * 缺省返回""
     *
     * @param name
     * @return
     */
    String getString(String name);

    /**
     * 取得字符串
     *
     * @param name
     * @param defaultValue
     * @return
     */
    String getString(String name, String defaultValue);

    /**
     * 設置字符串參數
     * @param name
     * @param value
     */
    void setString(String name, String value);


    /**
     * 檢測順序："1"， "true" ，"yes" ， "on"
     * 缺省返回false
     *
     * @param name
     * @return
     */
    boolean getBoolean(String name);

    /**
     * 取得boolean value
     * 檢測順序："1"， "true" ，"yes" ， "on"
     *
     * @param name
     * @param defaultValue
     * @return
     */
    boolean getBoolean(String name, boolean defaultValue);

    /**
     * 設置boolean參數
     * @param name
     * @param value
     */
    void setBoolean(String name, boolean value);

    /**
     * 缺省值：0D
     *
     * @param name
     * @return
     */
    double getDouble(String name);

    double getDouble(String name, double defaultValue);

    /**
     * 設置double參數
     * @param name
     * @param value
     */
    void setDouble(String name, double value);

    /**
     * 取得long參數
     * 缺省返回-1L
     *
     * @param name
     * @return
     */
    long getLong(String name);

    long getLong(String name, long defaultValue);

    /**
     * 設置long參數
     * @param name
     * @param value
     */
    void setLong(String name, long value);


    /**
     * 獲取整數參數
     *
     * @param name
     * @param defaultValue 缺省參數
     * @return
     */
    int getInt(String name, int defaultValue);

    /**
     * 取得int值
     * 缺省返回0
     *
     * @param name
     * @return
     */
    int getInt(String name);

    /**
     * 設置int參數
     * @param name
     * @param value
     */
    void setInt(String name, int value);


}