程序包 net.sohelp.boot.dev.web.dev.report

类 ReportController

java.lang.Object

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

net.sohelp.boot.dev.web.dev.report.ReportController

@RestController("dev-report")
@RequestMapping("/dev/report")
public class ReportController
extends BaseController

报表管理

从以下版本开始:

2024/7/25 19:15

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器	说明
ReportController()

方法概要

修饰符和类型	方法	说明
ApiResult<String>	add(Map<String,Object> dataMap)	添加报表接口 该接口用于添加一个新的报表，需要传入包含应用名称、模块名称、报表类型和报表名称等信息的Map对象。
ApiResult<String>	delete(List<Map<String,Object>> dataMaps)	删除指定的报表文件 该接口接收一个包含多个报表信息的列表，根据每个报表信息中的appName、moduleName和name拼接文件路径，并删除对应的报表文件。
ApiResult<Pager<com.alibaba.fastjson.JSONObject>>	page(String appName, String moduleName, String reportName)	分页查询报表信息 根据应用名称、模块名称和报表名称分页查询报表信息，返回报表的分页列表。
ApiResult<String>	update(Map<String,Object> dataMap)	更新报表信息接口 该接口用于更新指定应用下的模块报表信息，包括报表名称、备注、类型等。

从类继承的方法 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, response, responseStream, success, success, success, success, validateToken

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

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

构造器详细资料

ReportController

public ReportController()

方法详细资料

page

@Permission("ADMIN")
@GetMapping("/page")
public ApiResult<Pager<com.alibaba.fastjson.JSONObject>> page(@RequestParam(required=false)
 String appName,
 @RequestParam(required=false)
 String moduleName,
 @RequestParam(required=false)
 String reportName)

分页查询报表信息 根据应用名称、模块名称和报表名称分页查询报表信息，返回报表的分页列表。

参数:

appName - 应用名称，可选参数

moduleName - 模块名称，可选参数

reportName - 报表名称，可选参数

返回:

ApiResult无效输入：'<'Pager> 包含报表分页信息的ApiResult对象

delete

@Permission("ADMIN")
@PostMapping("/delete")
public ApiResult<String> delete(@RequestBody
 List<Map<String,Object>> dataMaps)
                         throws BusiException

删除指定的报表文件 该接口接收一个包含多个报表信息的列表，根据每个报表信息中的appName、moduleName和name拼接文件路径，并删除对应的报表文件。

参数:

dataMaps - 包含多个报表信息的列表，每个报表信息是一个Map，包含appName、moduleName和name三个键值对

返回:

返回操作结果的ApiResult对象，成功时返回"删除成功!"的消息

抛出:

BusiException - 如果appName、moduleName或name为空，则抛出BusiException异常

add

@Permission("ADMIN")
@PostMapping("/add")
public ApiResult<String> add(@RequestBody
 Map<String,Object> dataMap)
                      throws SQLException,
BusiException

添加报表接口 该接口用于添加一个新的报表，需要传入包含应用名称、模块名称、报表类型和报表名称等信息的Map对象。

参数:

dataMap - 包含报表信息的Map对象，其中必须包含"appName"（应用名称）、"moduleName"（模块名称）、"type"（报表类型）和"name"（报表名称）

返回:

ApiResult 返回操作结果的ApiResult对象，成功时包含"添加成功!"的消息，失败时包含相应的错误信息

抛出:

SQLException - 如果数据库操作出现异常，则抛出SQLException

BusiException - 如果业务逻辑出现异常，则抛出BusiException

update

@Permission("ADMIN")
@PostMapping("/update")
public ApiResult<String> update(@RequestBody
 Map<String,Object> dataMap)
                         throws SQLException,
BusiException

更新报表信息接口 该接口用于更新指定应用下的模块报表信息，包括报表名称、备注、类型等。

参数:

dataMap - 包含更新报表所需的数据，包括appName(应用名称)、moduleName(模块名称)、type(报表类型)、name(报表名称)、notes(报表备注)

返回:

返回ApiResult对象，包含操作结果信息

抛出:

SQLException - 数据库操作异常

BusiException - 业务逻辑异常，例如参数校验不通过或报表不存在