net.sohelp.boot.engine.web.controller

类 ModuleCustomController

java.lang.Object

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

net.sohelp.boot.engine.web.controller.ModuleCustomController

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

用户个性化布局界面

从以下版本开始:

2024/12/21 10:36

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
ModuleCustomController()

方法概要

限定符和类型	方法和说明
ApiResult<com.alibaba.fastjson.JSONObject>	readEntityForm(String refid) 读取用户个性化实体表单 根据提供的refid读取用户个性化实体表单数据，并返回结果
ApiResult<com.alibaba.fastjson.JSONObject>	readEntityLayout(String refid) 读取用户个性化实体布局 该接口用于根据用户提供的refid读取对应的个性化实体布局信息。
ApiResult<com.alibaba.fastjson.JSONObject>	readGrid(String refid) 读取用户个性化模块数据 通过传入的refid参数，读取并返回用户个性化模块的数据
ApiResult<com.alibaba.fastjson.JSONObject>	readLayout(String refid) 读取用户个性化布局接口 该接口用于根据用户提供的refid读取用户的个性化布局信息
ApiResult<com.alibaba.fastjson.JSONObject>	readModule(String refid) 读取用户个性化模块 根据传入的refid读取用户个性化模块信息

从类继承的方法 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

构造器详细资料

ModuleCustomController

public ModuleCustomController()

方法详细资料

readGrid

@GetMapping(value="/readGrid")
 @Permission(value="")
public ApiResult<com.alibaba.fastjson.JSONObject> readGrid(@RequestParam
                                                                                                                   String refid)
                                                                                                            throws TokenAuthenticationException,
                                                                                                                   BusiException,
                                                                                                                   AccessPermissionException,
                                                                                                                   SQLException

读取用户个性化模块数据 通过传入的refid参数，读取并返回用户个性化模块的数据

参数:

refid - 用户个性化模块的引用ID，格式为"xxx/yyy/zzz!www"，其中zzz和www分别表示模块和子模块

返回:

返回包含用户个性化模块数据的ApiResult对象

抛出:

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

BusiException - 如果业务处理过程中发生异常，则抛出此异常

AccessPermissionException - 如果访问权限不足，则抛出此异常

SQLException - 如果数据库访问过程中发生异常，则抛出此异常

readLayout

@GetMapping(value="/readLayout")
 @Permission(value="")
public ApiResult<com.alibaba.fastjson.JSONObject> readLayout(@RequestParam
                                                                                                                       String refid)
                                                                                                                throws TokenAuthenticationException,
                                                                                                                       BusiException,
                                                                                                                       SQLException,
                                                                                                                       AccessPermissionException

读取用户个性化布局接口 该接口用于根据用户提供的refid读取用户的个性化布局信息

参数:

refid - 用户提供的引用ID，包含布局信息的相关路径和模块

返回:

返回包含用户个性化布局信息的JSONObject对象

抛出:

TokenAuthenticationException - 当令牌认证失败时抛出

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

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

AccessPermissionException - 当访问权限验证失败时抛出

readModule

@GetMapping(value="/readModule")
 @Permission(value="")
public ApiResult<com.alibaba.fastjson.JSONObject> readModule(@RequestParam
                                                                                                                       String refid)
                                                                                                                throws TokenAuthenticationException,
                                                                                                                       BusiException,
                                                                                                                       SQLException,
                                                                                                                       AccessPermissionException

读取用户个性化模块 根据传入的refid读取用户个性化模块信息

参数:

refid - 用户个性化模块的引用ID，格式为"xx/xx/xx!xx"

返回:

返回包含模块信息的JSON对象

抛出:

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

BusiException - 如果业务处理过程中发生异常，则抛出此异常

SQLException - 如果数据库操作发生异常，则抛出此异常

AccessPermissionException - 如果访问权限不足，则抛出此异常

readEntityForm

@GetMapping(value="/readEntityForm")
 @Permission(value="")
public ApiResult<com.alibaba.fastjson.JSONObject> readEntityForm(@RequestParam
                                                                                                                               String refid)
                                                                                                                        throws TokenAuthenticationException,
                                                                                                                               BusiException,
                                                                                                                               SQLException,
                                                                                                                               AccessPermissionException

读取用户个性化实体表单 根据提供的refid读取用户个性化实体表单数据，并返回结果

参数:

refid - 表单引用ID，格式为"xxx/xxx/module!subModule"

返回:

ApiResult 包含实体表单数据的JSON对象

抛出:

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

BusiException - 如果业务处理过程中发生异常，则抛出此异常

SQLException - 如果数据库操作发生异常，则抛出此异常

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

readEntityLayout

@GetMapping(value="/readEntityLayout")
 @Permission(value="")
public ApiResult<com.alibaba.fastjson.JSONObject> readEntityLayout(@RequestParam
                                                                                                                                   String refid)
                                                                                                                            throws TokenAuthenticationException,
                                                                                                                                   BusiException,
                                                                                                                                   SQLException,
                                                                                                                                   AccessPermissionException

读取用户个性化实体布局 该接口用于根据用户提供的refid读取对应的个性化实体布局信息。

参数:

refid - 用户提供的引用ID，用于定位具体的实体布局信息

返回:

返回一个ApiResult对象，其中包含了JSONObject类型的实体布局信息

抛出:

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

BusiException - 如果业务处理过程中发生异常，则抛出此异常

SQLException - 如果数据库操作发生异常，则抛出此异常

AccessPermissionException - 如果访问权限不足，则抛出此异常