net.sohelp.boot.engine.web.controller

类 EngineReportController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.engine.web.controller.EngineReportController

@RestController(value="engine-web-report")
 @RequestMapping(value="/engine/web/report")
 @ConditionalOnExpression(value="${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.report.enabled:true}")
public class EngineReportController
extends BaseController

报表引擎控制器 提供报表相关的RESTful接口，包括查询、删除和保存等操作。

从以下版本开始:

2023/8/17 20:06

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器和说明
EngineReportController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	delete(String refid) 删除操作接口 接收refid参数，解析后调用服务层执行删除操作。
ApiResult<Object>	history(String refid) 获取打印历史接口 该接口用于获取指定引用ID的导入历史记录
ApiResult<List<Map<String,Object>>>	list(String refid) 根据refid获取报告列表 解析传入的refid参数，并根据解析结果从服务层获取对应的报告信息列表。
ApiResult<String>	save(List<Map<String,Object>> data) 保存次序接口 该接口接收一个包含数据的列表，目前未实现具体业务逻辑，直接返回成功响应。

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

EngineReportController

public EngineReportController()

方法详细资料

list

@GetMapping(value="/list")
 @Permission(value="")
public ApiResult<List<Map<String,Object>>> list(@RequestParam(required=false)
                                                                                                    String refid)
                                                                                             throws BusiException

根据refid获取报告列表 解析传入的refid参数，并根据解析结果从服务层获取对应的报告信息列表。

参数:

refid - 报告的唯一标识符（格式：应用名/模块名!报表名称）

返回:

ApiResult>> 包含报告列表的ApiResult对象， 每个元素是一个Map结构，包含appName、moduleName、uuid、createDate、type、name、notes和refid字段

抛出:

BusiException - 当refid解析失败或业务逻辑出错时抛出

delete

@PostMapping(value="/delete")
 @Permission(value="")
public ApiResult<String> delete(@RequestBody
                                                                                       String refid)
                                                                                throws BusiException,
                                                                                       SQLException

删除操作接口 接收refid参数，解析后调用服务层执行删除操作。

参数:

refid - 要删除的报表的唯一标识符（格式：应用名/模块名!报表名称）

返回:

ApiResult 返回操作结果的ApiResult对象，其中包含"删除成功"的成功消息

抛出:

BusiException - 当refid解析失败或业务逻辑出错时抛出

SQLException - 当数据库操作失败时抛出

save

@PostMapping(value="/save")
 @Permission(value="")
public ApiResult<String> save(@RequestBody
                                                                                   List<Map<String,Object>> data)
                                                                            throws BusiException,
                                                                                   SQLException

保存次序接口 该接口接收一个包含数据的列表，目前未实现具体业务逻辑，直接返回成功响应。

参数:

data - 要处理的数据列表，每个元素是键值对形式的数据项

返回:

ApiResult 返回操作结果的ApiResult对象，默认返回空的成功响应

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

SQLException - 数据库异常，当数据库操作失败时抛出

history

@GetMapping(value="/history")
 @Permission(value="")
public ApiResult<Object> history(@RequestParam(required=false)
                                                                                        String refid)
                                                                                 throws BusiException,
                                                                                        TokenAuthenticationException,
                                                                                        AccessPermissionException,
                                                                                        SQLException

获取打印历史接口 该接口用于获取指定引用ID的导入历史记录

参数:

refid - 引用ID，用于标识需要查询的导入历史记录，非必填参数

返回:

返回ApiResult对象，包含导入历史记录信息

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

AccessPermissionException - 如果访问权限验证失败，则抛出AccessPermissionException异常

SQLException - 如果数据库查询出现异常，则抛出SQLException异常