com.logicbus.models.servant.ServiceDescription Maven / Gradle / Ivy
package com.logicbus.models.servant;
import com.anysoft.util.Properties;
import com.anysoft.util.Reportable;
import com.anysoft.util.XmlSerializer;
import com.anysoft.util.JsonSerializer;
/**
* 服务描述
*
* @author duanyy
* @version 1.0.3 [20140410 duanyy]
* + 增加调用参数列表
*
* @version 1.0.8 [20140421 duanyy]
* - 修正{@link com.logicbus.models.servant.ServiceDescription#getArgument(String) getArgument(String)}空指针错误.
*
* @version 1.2.3 [20140617 duanyy]
* - 增加日志的相关属性
*
* @version 1.2.4.4 [20140709 duanyy]
* - 增加LogType的设置方法
* - 增加properties和arguments的设置方法
*
* @version 1.2.5.4 [20140801 duanyy]
* - ServiceDescription变更为interface
*
* @version 1.2.8.2 [20141015 duanyy]
* - 实现Reportable
*/
public interface ServiceDescription extends XmlSerializer,JsonSerializer,Reportable{
/**
* 业务日志的类型
*
*
* 分为三种类型:
* - none
* - brief
* - detail
*
* @author duanyy
* @since 1.2.3
*
*/
public enum LogType {none,brief,detail};
/**
* 获取日志类型
* @return 日志类型
*/
public LogType getLogType();
/**
* 获得服务ID
* @return 服务ID
*/
public String getServiceID();
/**
* 获得服务的可见性
* @return 可见性
*/
public String getVisible();
/**
* 获得服务名称
* @return name
*/
public String getName();
/**
* 获取服务说明
* @return 服务说明
*/
public String getNote();
/**
* 获得服务路径
* @return 服务路径
*/
public String getPath();
/**
* 获得服务实现代码
* @return 服务实现代码
*/
public String getModule();
/**
* 获取参数变量集
* @return 参数变量集
*/
public Properties getProperties();
/**
* 获取服务依赖库文件列表
* @return 文件列表
*/
public String [] getModules();
/**
* 获取服务调用参数列表
* @return 调用参数列表
* @since 1.0.3
*/
public Argument [] getArgumentList();
/**
* 获取指定ID的参数
* @param id 参数Id
* @return 指定ID的参数
*/
public Argument getArgument(String id);
}