wee0.IWee0 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wee0-api Show documentation
The newest version!
/**
 * Copyright (c) 2016-2022, wee0.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 wee0;

import wee0.codec.ISerializer;
import wee0.config.IConfig;
import wee0.core.IBindings;
import wee0.core.IDestroyable;
import wee0.core.IProgramManager;
import wee0.lang.IObject;
import wee0.lang.IObjects;

/**
 * Wee0框架核心操作接口。
 * @author		baihw
 * @date 		2016年12月24日
 **/

/**
 *  *  examples:
 * 
 **/

public interface IWee0 extends IDestroyable{

	/**
	 * 获取应用唯一标识。
	 * 
	 * @return 应用唯一标识
	 */
	String getAppId();

	/**
	 * 获取userConfig配置信息管理对象。
	 * 
	 * @return userConfig配置信息管理对象
	 */
	IConfig getUserConfig();

	/**
	 * 获取基础对象类型操作门面类实现实例。
	 * 
	 * @return 基础对象类型操作门面类实现实例
	 */
	IObjects getObjects();

	/**
	 * 获取序列化操作门面类实现实例。
	 * 
	 * @return 序列化操作门面类实现实例
	 */
	ISerializer getSerializer();

	/**
	 * 获取程序对象管理器。
	 * 
	 * @return 程序对象管理器
	 */
	public IProgramManager getProgramManager();

	/**
	 * 执行指定标识的程序对象功能函数。外部调度逻辑。
	 * 
	 * @param data 执行环境绑定数据对象
	 * @param programId 程序对象标识
	 * @param functionId 功能函数标识
	 */
	void runFunction( IBindings data, String programId, String functionId );

	/**
	 * 调用指定唯一标识的指令。
	 * 
	 * @param data 执行环境绑定数据
	 * @param commandId 指令标识
	 * @param args 参数列表
	 * @return 指令执行结果
	 */
	IObject runCommand( IBindings data, String commandId, IObject... args );

	/**
	 * 增加一个资源销毁者对象，所有的资源销毁者将会在需要销毁资源时，统一进行资源销毁。
	 * 
	 * @param destroyer 资源销毁者对象
	 */
	void addDestroyer( IDestroyable destroyer );

} // end interface