net.sohelp.boot.demo.web.system.tenant

类 TenantController

java.lang.Object

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

net.sohelp.boot.demo.web.system.tenant.TenantController

@RestController(value="admin-system-tenant")
 @RequestMapping(value="/admin/system/tenant")
public class TenantController
extends BaseController

租户管理控制器，提供租户相关的增删改查接口。

从以下版本开始:

2022/8/2

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
TenantController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	add(Map<String,Object> paramMap) 添加新的租户信息。
ApiResult<String>	delete(Map<String,Object> paramMap) 删除指定ID的租户信息。
ApiResult<Map<String,Object>>	getById(String id) 根据ID获取单个租户详细信息。
ApiResult<List<Map<String,Object>>>	list() 获取所有租户列表。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap) 分页查询租户信息。
ApiResult<String>	save(Map<String,Object> paramMap) 保存租户信息：若ID为空则新增，否则更新现有记录。
ApiResult<String>	update(Map<String,Object> paramMap) 更新已有租户信息。

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

构造器详细资料

TenantController

public TenantController()

方法详细资料

page

@GetMapping(value="/page")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
                                                                                                     Map<String,Object> paramMap)
                                                                                              throws Exception

分页查询租户信息。

参数:

paramMap - 查询参数集合，支持模糊匹配租户名称（tenant_name）和备注（comments）

返回:

返回分页结果对象，包含当前页数据及分页信息

抛出:

Exception - 数据库操作异常或其他系统异常

list

@GetMapping(value="/list")
 @Permission(value="")
public ApiResult<List<Map<String,Object>>> list()
                                                                                             throws Exception

获取所有租户列表。

返回:

返回所有租户记录组成的列表

抛出:

Exception - 数据库操作异常或其他系统异常

add

@PostMapping(value="/add")
 @Permission(value="DEVELOPER")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u6dfb\u52a0\u79df\u6237")
public ApiResult<String> add(@RequestBody
                                                                                                                                                                                                    Map<String,Object> paramMap)
                                                                                                                                                                                             throws Exception

添加新的租户信息。

参数:

paramMap - 包含租户信息的参数映射表，必须包括租户名称（tenant_name）

返回:

操作结果提示信息

抛出:

Exception - 数据库操作异常或其他系统异常

delete

@PostMapping(value="/delete")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="DEVELOPER")
 @OperationLog(value="\u5220\u9664\u79df\u6237")
public ApiResult<String> delete(@RequestBody
                                                                                                                                                                                                          Map<String,Object> paramMap)
                                                                                                                                                                                                   throws Exception

删除指定ID的租户信息。

参数:

paramMap - 参数映射表，必须包含要删除的租户ID（id）

返回:

操作结果提示信息

抛出:

Exception - 数据库操作异常或其他系统异常

getById

@GetMapping(value="/getById")
 @Permission(value="")
public ApiResult<Map<String,Object>> getById(@RequestParam
                                                                                                    String id)
                                                                                             throws Exception

根据ID获取单个租户详细信息。

参数:

id - 要查询的租户唯一标识符

返回:

返回该租户的信息映射表

抛出:

Exception - 数据库操作异常或其他系统异常

update

@PostMapping(value="/update")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u66f4\u65b0\u79df\u6237")
 @Permission(value="DEVELOPER")
public ApiResult<String> update(@RequestBody
                                                                                                                                                                                                          Map<String,Object> paramMap)
                                                                                                                                                                                                   throws Exception

更新已有租户信息。

参数:

paramMap - 包含更新后租户信息的参数映射表，必须包含租户ID（id）

返回:

操作结果提示信息

抛出:

Exception - 数据库操作异常或其他系统异常

save

@PostMapping(value="/save")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="DEVELOPER")
public ApiResult<String> save(@RequestBody
                                                                                                                                                    Map<String,Object> paramMap)
                                                                                                                                             throws SQLException,
                                                                                                                                                    EntityException,
                                                                                                                                                    EntityEventException,
                                                                                                                                                    EntityValidateException,
                                                                                                                                                    EntityFormulaException,
                                                                                                                                                    DuplicateKeyException

保存租户信息：若ID为空则新增，否则更新现有记录。

参数:

paramMap - 包含租户信息的参数映射表，必须包括租户名称（tenant_name），可选ID用于判断是新增还是更新

返回:

操作结果提示信息

抛出:

SQLException - SQL执行错误

EntityException - 实体处理异常

EntityEventException - 实体事件处理异常

EntityValidateException - 实体验证失败异常

EntityFormulaException - 公式计算异常

DuplicateKeyException - 主键冲突异常