pagemodule.java

欢迎使用 FastJsp 开发框架! 编译说明： * 若要生成Api Javadoc文档

package com.onetsoft.fastjsp;

import java.util.Locale;
import java.util.Map;

/**
 * 页面布局
 * 注意：实现类应实现比较方法{@link this#equals(Object)}和{@link this#hashCode()}
 *
 * @since 3.1
 */
public interface PageModule {

    /**
     * 取得布局url标识
     * 注意：
     * 1.在pahtinfo为空时，将表示一个特殊的 welcome module，仅用于读取index.jsp页面。
     * 其它形式如："/forums/threads.html"则认为访问缺省页面模块的threads.html
     * 单个系统中，此值一般系统内唯一
     *
     * @return e.g:null or "" or "admin" or "bbs" 不能包含其它如 '.' or  '/'等非ascii字符
     * @see PageParams
     */
    String getHrefChild();


    /**
     * 取得布局类相对位置
     * <p/>
     * 注，完整模板路径表示为：{@link Configuration#getPagePackageBase()}+
     * {@link #getPackageChild()}
     *
     * @return Empty value when no sub package  e.g:"a" ,"a.b"
     */
    String getPackageChild();

    /**
     * 取得布局模板相对位置
     * <p/>
     * 注，完整模板路径表示为：{@link Configuration#getPageTemplateBase()}+
     * {@link PageModule#getTemplateChild()}+
     * {@link AbstractServicer#getTemplateChild()}
     *
     * @return Empty value when no sub template path   e.g:"a","a/b/c"
     */
    String getTemplateChild();

    /**
     * 取得本模块 i18n 字符串资源
     * 读取顺序：本模块资源 -> 全局资源
     *
     * @param locale
     * @return
     * @see Configuration#getMessagesFactory()
     */
    Map getI18nStrings(Locale locale);


    /**
     * 缺省页面类
     * 用以提供“纯jsp页面”支持
     * 注：
     * 1.此类应具有空构造函数
     * 2.若不指定(即返回 null )，则空页面构造时会出现找不到类错误(404信息)。这样会混淆“确实”不存在页面的错误。
     * 3.缺省页面类往往跟某“布局”页面有切实的关联，在无须action、表单时，“缺省类”页面使用更灵活，而且无须再添加的java页面类。
     * @return
     */
    Class getDefaultPage();


    /**
     * 取得本模块的页面错误处理
     * 此类建议继承自类{@link AbstractExceptionHandler}
     *
     * @return
     */
    ExceptionHandler getExceptionHandler();
}