IDCDatasync-vue/public/codeInstructions/org/chinandc/idcds/common/api/CommonAPI.html

419 lines
17 KiB
HTML
Raw Normal View History

2025-01-15 20:19:34 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (1.8.0_131) on Fri May 28 08:39:42 GMT+08:00 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>CommonAPI</title>
<meta name="date" content="2021-05-28">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommonAPI";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-files/index-1.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>上一个类</li>
<li><a href="../../../../../org/chinandc/idcds/common/api/IWpsBaseAPI.html" title="org.chinandc.idcds.common.api中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/chinandc/idcds/common/api/CommonAPI.html" target="_top">框架</a></li>
<li><a href="CommonAPI.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.chinandc.idcds.common.api</div>
<h2 title="接口 CommonAPI" class="title">接口 CommonAPI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知子接口:</dt>
<dd><a href="../../../../../org/chinandc/idcds/common/system/api/ISysBaseAPI.html" title="org.chinandc.idcds.common.system.api中的接口">ISysBaseAPI</a></dd>
</dl>
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../../org/chinandc/idcds/common/system/api/fallback/SysBaseAPIFallback.html" title="org.chinandc.idcds.common.system.api.fallback中的类">SysBaseAPIFallback</a>, <a href="../../../../../org/chinandc/idcds/modules/system/service/impl/SysBaseApiImpl.html" title="org.chinandc.idcds.modules.system.service.impl中的类">SysBaseApiImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CommonAPI</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/chinandc/idcds/common/system/vo/SysUserCacheInfo.html" title="org.chinandc.idcds.common.system.vo中的类">SysUserCacheInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#getCacheUser-java.lang.String-">getCacheUser</a></span>(java.lang.String&nbsp;username)</code>
<div class="block">9查询用户信息</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/chinandc/idcds/common/system/vo/DynamicDataSourceModel.html" title="org.chinandc.idcds.common.system.vo中的类">DynamicDataSourceModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#getDynamicDbSourceByCode-java.lang.String-">getDynamicDbSourceByCode</a></span>(java.lang.String&nbsp;dbSourceCode)</code>
<div class="block">4根据 code 查询数据库中存储的 DynamicDataSourceModel</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/chinandc/idcds/common/system/vo/DynamicDataSourceModel.html" title="org.chinandc.idcds.common.system.vo中的类">DynamicDataSourceModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#getDynamicDbSourceById-java.lang.String-">getDynamicDbSourceById</a></span>(java.lang.String&nbsp;dbSourceId)</code>
<div class="block">3根据 id 查询数据库中存储的 DynamicDataSourceModel</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/chinandc/idcds/common/system/vo/LoginUser.html" title="org.chinandc.idcds.common.system.vo中的类">LoginUser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#getUserByName-java.lang.String-">getUserByName</a></span>(java.lang.String&nbsp;username)</code>
<div class="block">5根据用户账号查询用户信息</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/chinandc/idcds/common/system/vo/SysPermissionDataRuleModel.html" title="org.chinandc.idcds.common.system.vo中的类">SysPermissionDataRuleModel</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#queryPermissionDataRule-java.lang.String-java.lang.String-java.lang.String-">queryPermissionDataRule</a></span>(java.lang.String&nbsp;component,
java.lang.String&nbsp;requestPath,
java.lang.String&nbsp;username)</code>
<div class="block">8查询数据权限</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#queryUserAuths-java.lang.String-">queryUserAuths</a></span>(java.lang.String&nbsp;username)</code>
<div class="block">2查询用户权限信息</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#queryUserRoles-java.lang.String-">queryUserRoles</a></span>(java.lang.String&nbsp;username)</code>
<div class="block">1查询用户角色信息</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#translateDict-java.lang.String-java.lang.String-">translateDict</a></span>(java.lang.String&nbsp;code,
java.lang.String&nbsp;key)</code>
<div class="block">7普通字典的翻译</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/chinandc/idcds/common/api/CommonAPI.html#translateDictFromTable-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">translateDictFromTable</a></span>(java.lang.String&nbsp;table,
java.lang.String&nbsp;text,
java.lang.String&nbsp;code,
java.lang.String&nbsp;key)</code>
<div class="block">6字典表的 翻译</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="queryUserRoles-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryUserRoles</h4>
<pre>java.util.Set&lt;java.lang.String&gt;&nbsp;queryUserRoles(java.lang.String&nbsp;username)</pre>
<div class="block">1查询用户角色信息</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>username</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="queryUserAuths-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryUserAuths</h4>
<pre>java.util.Set&lt;java.lang.String&gt;&nbsp;queryUserAuths(java.lang.String&nbsp;username)</pre>
<div class="block">2查询用户权限信息</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>username</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="getDynamicDbSourceById-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDynamicDbSourceById</h4>
<pre><a href="../../../../../org/chinandc/idcds/common/system/vo/DynamicDataSourceModel.html" title="org.chinandc.idcds.common.system.vo中的类">DynamicDataSourceModel</a>&nbsp;getDynamicDbSourceById(java.lang.String&nbsp;dbSourceId)</pre>
<div class="block">3根据 id 查询数据库中存储的 DynamicDataSourceModel</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>dbSourceId</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="getDynamicDbSourceByCode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDynamicDbSourceByCode</h4>
<pre><a href="../../../../../org/chinandc/idcds/common/system/vo/DynamicDataSourceModel.html" title="org.chinandc.idcds.common.system.vo中的类">DynamicDataSourceModel</a>&nbsp;getDynamicDbSourceByCode(java.lang.String&nbsp;dbSourceCode)</pre>
<div class="block">4根据 code 查询数据库中存储的 DynamicDataSourceModel</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>dbSourceCode</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="getUserByName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserByName</h4>
<pre><a href="../../../../../org/chinandc/idcds/common/system/vo/LoginUser.html" title="org.chinandc.idcds.common.system.vo中的类">LoginUser</a>&nbsp;getUserByName(java.lang.String&nbsp;username)</pre>
<div class="block">5根据用户账号查询用户信息</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>username</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="translateDictFromTable-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateDictFromTable</h4>
<pre>java.lang.String&nbsp;translateDictFromTable(java.lang.String&nbsp;table,
java.lang.String&nbsp;text,
java.lang.String&nbsp;code,
java.lang.String&nbsp;key)</pre>
<div class="block">6字典表的 翻译</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>table</code> - </dd>
<dd><code>text</code> - </dd>
<dd><code>code</code> - </dd>
<dd><code>key</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="translateDict-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateDict</h4>
<pre>java.lang.String&nbsp;translateDict(java.lang.String&nbsp;code,
java.lang.String&nbsp;key)</pre>
<div class="block">7普通字典的翻译</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>code</code> - </dd>
<dd><code>key</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="queryPermissionDataRule-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryPermissionDataRule</h4>
<pre>java.util.List&lt;<a href="../../../../../org/chinandc/idcds/common/system/vo/SysPermissionDataRuleModel.html" title="org.chinandc.idcds.common.system.vo中的类">SysPermissionDataRuleModel</a>&gt;&nbsp;queryPermissionDataRule(java.lang.String&nbsp;component,
java.lang.String&nbsp;requestPath,
java.lang.String&nbsp;username)</pre>
<div class="block">8查询数据权限</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
<a name="getCacheUser-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCacheUser</h4>
<pre><a href="../../../../../org/chinandc/idcds/common/system/vo/SysUserCacheInfo.html" title="org.chinandc.idcds.common.system.vo中的类">SysUserCacheInfo</a>&nbsp;getCacheUser(java.lang.String&nbsp;username)</pre>
<div class="block">9查询用户信息</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>username</code> - </dd>
<dt><span class="returnLabel">返回:</span></dt>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-files/index-1.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>上一个类</li>
<li><a href="../../../../../org/chinandc/idcds/common/api/IWpsBaseAPI.html" title="org.chinandc.idcds.common.api中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/chinandc/idcds/common/api/CommonAPI.html" target="_top">框架</a></li>
<li><a href="CommonAPI.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>