// 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;

import com.onetsoft.fastjsp.request.PageData;
import com.onetsoft.fastjsp.valid.ValidationDelegate;

/**
 * 定義組件接口
 * 同一組件在同一頁面中只能實際使用一次
 *
 * @author <a href="mailto:hgw@onetsoft.com">hgw</a>
 */
public interface Component {

    /**
     * 取得表單JavaScript支持
     * 應在需要js支持的表單后調用此方法
     *
     * @param formName
     * @return
     */
    String getScriptSupport(String formName);

    /**
     * 取得頁面i18n國際化字符串資源
     *
     * @return
     */
    Messages getMessages();


    /**
     * 取得頁面內的某組件
     * 注:若沒有,則返回null
     *
     * @param clazz
     * @return
     */
    Component getComponent(Class clazz);

    /**
     * 取得驗證代理
     * 通過此取得表單驗證錯誤信息
     *
     * @return
     */
    ValidationDelegate getValidationDelegate();

    /**
     * 取得當前頁面
     *
     * @return
     */
    Page getPage();

    /**
     * 取得頁面數據
     *
     * @return
     */
    PageData getData();

    /**
     * 取得 page cycle
     *
     * @return
     */
    PageCycle getCycle();

    /**
     * 取得當前頁面的url link
     *
     * @return
     */
    Link getLink();

    /**
     * 當前布局范圍內的頁面鏈接
     *
     * @param pageName e.g:"index"    注：不包括頁面擴展名
     * @return
     */
    Link getLink(String pageName);

    /**
     * 指定布局范圍內的鏈接
     *
     * @param layoutModule
     * @param pageName
     * @return
     */
    Link getLink(PageModule layoutModule, String pageName);

 
    
}