程序包 net.risesoft.api.platform.tenant

接口 TenantApi

  • @Validated
public interface TenantApi
    租户管理组件
    从以下版本开始:
    9.6.0
    作者:
    dingzhaojun, qinman, mengjuhua
    Date:
    2022/2/10

    • 方法概要

      所有方法 实例方法 抽象方法 
      修饰符和类型 方法 说明
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> findByName​(@NotBlank String tenantName)
      根据租户名，获取租户
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> findByShortName​(@NotBlank String shortName)
      根据租户登录名称（租户英文名称），获取租户
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> getById​(@NotBlank String tenantId)
      根据租户id获取一个租户对象
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Tenant>> listAllTenants()
      获取所有租户对象
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Tenant>> listByTenantType​(net.risesoft.enums.platform.TenantTypeEnum tenantType)
      获取指定租户类型的所有租户对象

    • 方法详细资料

      • findByName

        @GetMapping("/findByName")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> findByName​(@RequestParam("tenantName") @NotBlank
                                                                          @NotBlank String tenantName)
        根据租户名，获取租户
        参数:
        tenantName - 租户名
        返回:
        Y9Result<Tenant> 通用请求返回对象 - data是租户对象
        从以下版本开始:
        9.6.0

      • findByShortName

        @GetMapping("/findByShortName")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> findByShortName​(@RequestParam("shortName") @NotBlank
                                                                               @NotBlank String shortName)
        根据租户登录名称（租户英文名称），获取租户
        参数:
        shortName - 租户登录名称（租户英文名称）
        返回:
        Y9Result<Tenant> 通用请求返回对象 - data 是租户对象
        从以下版本开始:
        9.6.0

      • getById

        @GetMapping("/getById")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Tenant> getById​(@RequestParam("tenantId") @NotBlank
                                                                       @NotBlank String tenantId)
        根据租户id获取一个租户对象
        参数:
        tenantId - 租户id
        返回:
        Y9Result<Tenant> 通用请求返回对象 - data 是租户对象
        从以下版本开始:
        9.6.0

      • listAllTenants

        @GetMapping("/listAllTenants")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Tenant>> listAllTenants()
        获取所有租户对象
        返回:
        Y9Result<List<Tenant>> 通用请求返回对象 - data是租户对象集合
        从以下版本开始:
        9.6.0

      • listByTenantType

        @GetMapping("/listByTenantType")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Tenant>> listByTenantType​(@RequestParam("tenantType")
                                                                                      net.risesoft.enums.platform.TenantTypeEnum tenantType)
        获取指定租户类型的所有租户对象
        参数:
        tenantType - 租户类型： 0=用户，2=开发商，1=运维团队，3=普通租户
        返回:
        Y9Result<List<Tenant>> 通用请求返回对象 - data是租户对象集合
        从以下版本开始:
        9.6.0