net.sohelp.boot.engine.web.controller

类 ModuleGridController

java.lang.Object

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

net.sohelp.boot.engine.web.controller.ModuleGridController

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

实体列表引擎

从以下版本开始:

2024/8/27 16:45

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
ModuleGridController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	resetCommonConfig(Map<String,Object> dataMap) 重置通用配置接口 该接口用于重置指定引用ID的通用配置
ApiResult<String>	save(Map<String,Object> dataMap) 保存实体表单数据 该接口用于接收前端传来的表单数据，并根据数据内容保存或更新对应的实体表单配置。
ApiResult<String>	saveGridFilterField(Map<String,Object> dataMap) 保存网格筛选字段 该接口用于保存用户设置的网格筛选字段，其他方案和排序不保存。
ApiResult<String>	saveGridFilterKeywords(Map<String,Object> dataMap) 保存网格筛选关键字 仅保存关键字筛选，其他方案和过滤字段不保存
ApiResult<String>	saveGridFilterScheme(Map<String,Object> dataMap) 保存网格筛选方案 该接口用于保存用户设置的网格筛选方案，只保存筛选方案，不保存其他排序和过滤设置。
ApiResult<String>	saveGridFilterSort(Map<String,Object> dataMap) 保存网格筛选排序接口 该接口用于保存用户设置的网格筛选和排序条件，不保存其他方案和过滤字段。
ApiResult<String>	saveGridList(Map<String,Object> dataMap) 保存网格列表接口 该接口用于保存用户提交的网格列表数据，根据refid获取相关信息并更新或创建网格数据。
ApiResult<String>	updateCommonConfig(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, success, success, success, success, validateToken

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

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

构造器详细资料

ModuleGridController

public ModuleGridController()

方法详细资料

updateCommonConfig

@PostMapping(value="/updateCommonConfig")
 @Permission(value="")
public ApiResult<String> updateCommonConfig(@RequestBody
                                                                                                               Map<String,Object> dataMap)
                                                                                                        throws BusiException,
                                                                                                               SQLException,
                                                                                                               EntityException

更新通用配置接口 该接口用于更新网格列表的通用配置，包括属性显示、宽度、锁定等设置。

参数:

dataMap - 包含更新配置所需数据的Map，其中必须包含"refid"和"properties"两个键。 - "refid"：网格列表的唯一标识，用于定位要更新的网格列表。 - "properties"：一个包含多个属性配置的列表，每个属性配置是一个Map，包含属性的名称、宽度、是否锁定等信息。

返回:

返回ApiResult对象，表示操作结果。成功时返回ok()，失败时返回错误信息。

抛出:

BusiException - 如果"refid"为空或格式不正确，或者网格列表不存在，则抛出BusiException异常。

SQLException - 如果在更新数据库时发生错误，则抛出SQLException异常。

EntityException

resetCommonConfig

@PostMapping(value="/resetCommonConfig")
 @Permission(value="")
public ApiResult<String> resetCommonConfig(@RequestBody
                                                                                                             Map<String,Object> dataMap)

重置通用配置接口 该接口用于重置指定引用ID的通用配置

参数:

dataMap - 请求体，包含需要重置配置的相关信息 - refid: 引用ID，用于标识需要重置配置的对象

返回:

返回操作结果，成功则返回ok

saveGridFilterScheme

@PostMapping(value="/saveGridFilterScheme")
 @Permission(value="")
public ApiResult<String> saveGridFilterScheme(@RequestBody
                                                                                                                   Map<String,Object> dataMap)
                                                                                                            throws BusiException,
                                                                                                                   SQLException,
                                                                                                                   EntityException

保存网格筛选方案 该接口用于保存用户设置的网格筛选方案，只保存筛选方案，不保存其他排序和过滤设置。

参数:

dataMap - 包含筛选方案数据的Map，其中必须包含"refid"键和对应的值，"filter"键和对应的筛选方案JSON字符串

返回:

返回操作结果的ApiResult对象，成功时返回结果为ok

抛出:

BusiException - 业务异常，当处理业务逻辑时发生错误抛出

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

EntityException

saveGridFilterSort

@PostMapping(value="/saveGridFilterSort")
 @Permission(value="")
public ApiResult<String> saveGridFilterSort(@RequestBody
                                                                                                               Map<String,Object> dataMap)
                                                                                                        throws BusiException,
                                                                                                               SQLException,
                                                                                                               EntityException

保存网格筛选排序接口 该接口用于保存用户设置的网格筛选和排序条件，不保存其他方案和过滤字段。

参数:

dataMap - 包含筛选排序信息的Map，其中必须包含"refid"键用于定位网格，"filter"键用于描述筛选排序条件

返回:

返回操作结果的ApiResult对象，其中包含操作成功或失败的信息

抛出:

BusiException - 当业务逻辑异常时抛出

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

EntityException

saveGridFilterKeywords

@PostMapping(value="/saveGridFilterKeywords")
 @Permission(value="")
public ApiResult<String> saveGridFilterKeywords(@RequestBody
                                                                                                                       Map<String,Object> dataMap)
                                                                                                                throws BusiException,
                                                                                                                       SQLException,
                                                                                                                       EntityException

保存网格筛选关键字 仅保存关键字筛选，其他方案和过滤字段不保存

参数:

dataMap - 包含筛选关键字的Map，其中key为"refid"的对应值为网格引用ID

返回:

操作成功的提示信息

抛出:

BusiException - 当根据refid找不到对应网格时抛出BusiException异常

SQLException - 数据库操作异常

EntityException

saveGridFilterField

@PostMapping(value="/saveGridFilterField")
 @Permission(value="")
public ApiResult<String> saveGridFilterField(@RequestBody
                                                                                                                 Map<String,Object> dataMap)
                                                                                                          throws BusiException,
                                                                                                                 SQLException,
                                                                                                                 EntityException

保存网格筛选字段 该接口用于保存用户设置的网格筛选字段，其他方案和排序不保存。

参数:

dataMap - 包含筛选字段信息的Map对象，其中必须包含"refid"键和对应的值

返回:

返回操作结果的ApiResult对象，成功时返回ok()

抛出:

BusiException - 业务异常，处理业务逻辑时可能抛出

SQLException - 数据库操作异常，执行数据库操作时可能抛出

EntityException

save

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

保存实体表单数据 该接口用于接收前端传来的表单数据，并根据数据内容保存或更新对应的实体表单配置。

参数:

dataMap - 包含表单数据的Map对象，其中必须包含"refid"键用于标识表单，"filter"键用于描述过滤条件，可选"limit"键用于描述每页显示行数，"list"键用于描述显示的字段列表

返回:

返回操作结果的ApiResult对象，其中包含操作成功或失败的信息

抛出:

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

SQLException - 当数据库操作出现错误时抛出

EntityException

saveGridList

@Permission(value="")
 @PostMapping(value="/saveGridList")
public ApiResult<String> saveGridList(@RequestBody
                                                                                                   Map<String,Object> dataMap)
                                                                                            throws BusiException,
                                                                                                   SQLException,
                                                                                                   EntityException

保存网格列表接口 该接口用于保存用户提交的网格列表数据，根据refid获取相关信息并更新或创建网格数据。

参数:

dataMap - 包含网格列表数据的Map，其中必须包含"refid"键和对应的值，"list"键为可选，包含字段名称列表

返回:

返回操作结果的ApiResult对象，其中包含操作成功或失败的信息

抛出:

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

SQLException - 当数据库操作出现错误时抛出

EntityException