javax.web.skeleton4j.script.WebScript Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of skeleton4j-api Show documentation
skeleton4j application interface module
There is a newer version: 1.0.2
/**
 * RNKRSOFT OPEN SOURCE SOFTWARE LICENSE TERMS ver.1
 * - 氡氪网络科技(重庆)有限公司 开源软件许可条款(版本1)
 * 氡氪网络科技(重庆)有限公司 以下简称Rnkrsoft。
 * 这些许可条款是 Rnkrsoft Corporation（或您所在地的其中一个关联公司）与您之间达成的协议。
 * 请阅读本条款。本条款适用于所有Rnkrsoft的开源软件项目，任何个人或企业禁止以下行为：
 * .禁止基于删除开源代码所附带的本协议内容、
 * .以非Rnkrsoft的名义发布Rnkrsoft开源代码或者基于Rnkrsoft开源源代码的二次开发代码到任何公共仓库,
 * 除非上述条款附带有其他条款。如果确实附带其他条款，则附加条款应适用。
 * 
 * 使用该软件，即表示您接受这些条款。如果您不接受这些条款，请不要使用该软件。
 * 如下所述，安装或使用该软件也表示您同意在验证、自动下载和安装某些更新期间传输某些标准计算机信息以便获取基于 Internet 的服务。
 * 

 * 如果您遵守这些许可条款，将拥有以下权利。
 * 1.阅读源代码和文档
 * 如果您是个人用户，则可以在任何个人设备上阅读、分析、研究Rnkrsoft开源源代码。
 * 如果您经营一家企业，则禁止在任何设备上阅读Rnkrsoft开源源代码,禁止分析、禁止研究Rnkrsoft开源源代码。
 * 2.编译源代码
 * 如果您是个人用户，可以对Rnkrsoft开源源代码以及修改后产生的源代码进行编译操作，编译产生的文件依然受本协议约束。
 * 如果您经营一家企业，不可以对Rnkrsoft开源源代码以及修改后产生的源代码进行编译操作。
 * 3.二次开发拓展功能
 * 如果您是个人用户，可以基于Rnkrsoft开源源代码进行二次开发，修改产生的元代码同样受本协议约束。
 * 如果您经营一家企业，不可以对Rnkrsoft开源源代码进行任何二次开发，但是可以通过联系Rnkrsoft进行商业授予权进行修改源代码。
 * 完整协议。本协议以及开源源代码附加协议，共同构成了Rnkrsoft开源软件的完整协议。
 * 
 * 4.免责声明
 * 该软件按“原样”授予许可。 使用本文档的风险由您自己承担。Rnkrsoft 不提供任何明示的担保、保证或条件。
 * 5.版权声明
 * 本协议所对应的软件为 Rnkrsoft 所拥有的自主知识产权，如果基于本软件进行二次开发，在不改变本软件的任何组成部分的情况下的而二次开发源代码所属版权为贵公司所有。
 */
package javax.web.skeleton4j.script;


import java.util.List;

/**
 * Created by rnkrsoft.com on 2017/10/12.
 * HTML 脚本封装对象接口
 */
public interface WebScript {
    /**
     * 所属的主题，如果与主题无关返回null
     * @return 主题名
     */
    String getTheme();

    /**
     * 获取别名
     *
     * @return 别名
     */
    String getAlias();

    /**
     * 设置别名
     *
     * @param alias 别名
     */
    void setAlias(String alias);

    /**
     * 获取版本号
     *
     * @return 版本号
     */
    String getVersion();

    /**
     * 版本号
     *
     * @param version 版本号
     */
    void setVersion(String version);

    /**
     * 获取文件存放地址
     * 例如classpath*:javax.web.skeleton4j.demo.js或者http://cdn.test.com/demo.js
     *
     * @return 地址
     */
    String getSource();

    /**
     * 设置文件存放地址
     * 例如classpath*:javax.web.skeleton4j.demo.js或者http://cdn.test.com/demo.js
     *
     * @param source 地址
     */
    void setSource(String source);

    /**
     * 获取脚本内容
     *
     * @return 脚本内容
     */
    String getContent();

    /**
     * 设置脚本内容
     *
     * @param content 脚本内容
     */
    void setContent(String content);

    /**
     * 是否内联
     *
     * @return 内联
     */
    boolean isInline();

    /**
     * 是否内联
     *
     * @param inline 内联
     */
    void setInline(boolean inline);

    /**
     * 非内联时，转换为服务器访问的地址
     *
     * @return 访问的地址
     */
    String getServerUrl();

    /**
     * 非内联时，转换为服务器访问的地址
     *
     * @param serverUrl 访问的地址
     */
    void setServerUrl(String serverUrl);

    /**
     * 提供此脚本的类对象，可能为标注@WebPage的类对象，也可能为标注@WebTheme的类对象
     *
     * @return 提供该脚本的类
     */
    String getProviderClass();

    /**
     * 提供此脚本的类对象，可能为标注@WebPage的类对象，也可能为标注@WebTheme的类对象
     *
     * @param providerClass 提供该脚本的类
     */
    void setProviderClass(String providerClass);

    /**
     * 该脚本依赖的其他脚本
     *
     * @return 以来脚本列表
     */
    List getDependencies();

    /**
     * 是否支持异步下载
     *
     * @return 异步下载
     */
    boolean isAsync();

    /**
     * 是否支持异步下载
     *
     * @param async 异步下载
     */
    void setAsync(boolean async);

    /**
     * 是否有内容
     *
     * @return 是否有内容
     */
    boolean hasContent();

}