DictAPI (Java SDK API Reference for AWS PaaS)

```
public interface DictAPI
```
基础字典应用API接口。该API必须在AWS安装'基础字典'后可用，由于比较公共，我们将该类API封装在平台级，方便开发者直接调用。

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`FIELD_BIG5NAME` 繁体名称
`static java.lang.String`	`FIELD_CNNAME` 中文名称
`static java.lang.String`	`FIELD_ENNAME` 英文名称
`static java.lang.String`	`FIELD_EXTDATE1` 扩展日期1
`static java.lang.String`	`FIELD_EXTDATE2` 扩展日期2
`static java.lang.String`	`FIELD_EXTDOUBLE1` 扩展浮点1
`static java.lang.String`	`FIELD_EXTDOUBLE2` 扩展浮点2
`static java.lang.String`	`FIELD_EXTDOUBLE3` 扩展浮点3
`static java.lang.String`	`FIELD_EXTINT1` 扩展整数1
`static java.lang.String`	`FIELD_EXTINT2` 扩展整数2
`static java.lang.String`	`FIELD_EXTINT3` 扩展整数3
`static java.lang.String`	`FIELD_EXTINT4` 扩展整数4
`static java.lang.String`	`FIELD_EXTINT5` 扩展整数5
`static java.lang.String`	`FIELD_EXTTEXT1` 扩展文本1
`static java.lang.String`	`FIELD_EXTTEXT10` 扩展文本10
`static java.lang.String`	`FIELD_EXTTEXT2` 扩展文本2
`static java.lang.String`	`FIELD_EXTTEXT3` 扩展文本3
`static java.lang.String`	`FIELD_EXTTEXT4` 扩展文本4
`static java.lang.String`	`FIELD_EXTTEXT5` 扩展文本5
`static java.lang.String`	`FIELD_EXTTEXT6` 扩展文本6
`static java.lang.String`	`FIELD_EXTTEXT7` 扩展文本7
`static java.lang.String`	`FIELD_EXTTEXT8` 扩展文本8
`static java.lang.String`	`FIELD_EXTTEXT9` 扩展文本9
`static java.lang.String`	`FIELD_ISACTIVE` 有效性
`static java.lang.String`	`FIELD_ISLEAF` 是否叶子节点
`static java.lang.String`	`FIELD_NO` 代码
`static java.lang.String`	`FIELD_PNO` 上级代码

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`java.lang.String`	`getValue(java.lang.String appId, java.lang.String dictKey, java.lang.String itemNo)` 获取指定字典配置项对应的名称
`java.lang.String`	`getValue(java.lang.String appId, java.lang.String dictKey, java.lang.String itemNo, java.lang.String valueFieldName)` 获取指定字典配置项对应的名称
`java.lang.String`	`getValue(java.lang.String appId, java.lang.String dictKey, java.lang.String keyValue, java.lang.String keyFieldName, java.lang.String valueFieldName)` 获取字典的配置项值，由指定的过滤字段和值进行匹配。
`JSONArray`	`queryValue(java.lang.String appId, java.lang.String dictKey)` 获取指定字典的全部配置项
`net.sf.json.JSONArray`	`queryValues(java.lang.String appId, java.lang.String dictKey)` 已过时。使用`queryValue(String, String)`方法替代

- 字段详细资料
  - FIELD_NO
```
static final java.lang.String FIELD_NO
```
    代码
    
    另请参阅:
    
    常量字段值
  - FIELD_CNNAME
```
static final java.lang.String FIELD_CNNAME
```
    中文名称
    
    另请参阅:
    
    常量字段值
  - FIELD_ENNAME
```
static final java.lang.String FIELD_ENNAME
```
    英文名称
    
    另请参阅:
    
    常量字段值
  - FIELD_BIG5NAME
```
static final java.lang.String FIELD_BIG5NAME
```
    繁体名称
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT1
```
static final java.lang.String FIELD_EXTTEXT1
```
    扩展文本1
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT2
```
static final java.lang.String FIELD_EXTTEXT2
```
    扩展文本2
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT3
```
static final java.lang.String FIELD_EXTTEXT3
```
    扩展文本3
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT4
```
static final java.lang.String FIELD_EXTTEXT4
```
    扩展文本4
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT5
```
static final java.lang.String FIELD_EXTTEXT5
```
    扩展文本5
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT6
```
static final java.lang.String FIELD_EXTTEXT6
```
    扩展文本6
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT7
```
static final java.lang.String FIELD_EXTTEXT7
```
    扩展文本7
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT8
```
static final java.lang.String FIELD_EXTTEXT8
```
    扩展文本8
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT9
```
static final java.lang.String FIELD_EXTTEXT9
```
    扩展文本9
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTTEXT10
```
static final java.lang.String FIELD_EXTTEXT10
```
    扩展文本10
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTINT1
```
static final java.lang.String FIELD_EXTINT1
```
    扩展整数1
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTINT2
```
static final java.lang.String FIELD_EXTINT2
```
    扩展整数2
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTINT3
```
static final java.lang.String FIELD_EXTINT3
```
    扩展整数3
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTINT4
```
static final java.lang.String FIELD_EXTINT4
```
    扩展整数4
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTINT5
```
static final java.lang.String FIELD_EXTINT5
```
    扩展整数5
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTDOUBLE1
```
static final java.lang.String FIELD_EXTDOUBLE1
```
    扩展浮点1
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTDOUBLE2
```
static final java.lang.String FIELD_EXTDOUBLE2
```
    扩展浮点2
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTDOUBLE3
```
static final java.lang.String FIELD_EXTDOUBLE3
```
    扩展浮点3
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTDATE1
```
static final java.lang.String FIELD_EXTDATE1
```
    扩展日期1
    
    另请参阅:
    
    常量字段值
  - FIELD_EXTDATE2
```
static final java.lang.String FIELD_EXTDATE2
```
    扩展日期2
    
    另请参阅:
    
    常量字段值
  - FIELD_ISACTIVE
```
static final java.lang.String FIELD_ISACTIVE
```
    有效性
    
    另请参阅:
    
    常量字段值
  - FIELD_PNO
```
static final java.lang.String FIELD_PNO
```
    上级代码
    
    另请参阅:
    
    常量字段值
  - FIELD_ISLEAF
```
static final java.lang.String FIELD_ISLEAF
```
    是否叶子节点
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - queryValue
```
JSONArray queryValue(java.lang.String appId,
                     java.lang.String dictKey)
```
    获取指定字典的全部配置项
    
    参数:
    
    appId - 应用调用者AppId，该应用必须声明了关联com.actionsoft.apps.dict
    
    dictKey - 字典名，该字典的关键字
    
    返回:
    
    一个JSONArray数组，可能返回null。key值参见本类的FIELD_*
    
    从以下版本开始:
    
    6.2.13
  - queryValues
```
@Deprecated
net.sf.json.JSONArray queryValues(java.lang.String appId,
                                               java.lang.String dictKey)
```
    已过时。使用queryValue(String, String)方法替代
    
    获取指定字典的全部配置项
    
    参数:
    
    appId - 应用调用者AppId，该应用必须声明了关联com.actionsoft.apps.dict
    
    dictKey - 字典名，该字典的关键字
    
    返回:
    
    一个JSONArray数组，可能返回null。key值参见本类的FIELD_*
  - getValue
```
java.lang.String getValue(java.lang.String appId,
                          java.lang.String dictKey,
                          java.lang.String itemNo)
```
    获取指定字典配置项对应的名称
    
    参数:
    
    appId - 应用调用者AppId，该应用必须声明了关联com.actionsoft.apps.dict
    
    dictKey - 字典名，该字典的关键字
    
    itemNo - 代码
    
    返回:
    
    返回代码对应的中文名称（CNNAME）
  - getValue
```
java.lang.String getValue(java.lang.String appId,
                          java.lang.String dictKey,
                          java.lang.String itemNo,
                          java.lang.String valueFieldName)
```
    获取指定字典配置项对应的名称
    
    参数:
    
    appId - 应用调用者AppId，该应用必须声明了关联com.actionsoft.apps.dict
    
    dictKey - 字典名，该字典的关键字
    
    itemNo - 代码
    
    valueFieldName - 取值字段名，如中文名叫CNNAME，系列扩展字段。见本API的FIELD_*常量
    
    返回:
    
    返回代码对应的值，取值由fieldName指定
  - getValue
```
java.lang.String getValue(java.lang.String appId,
                          java.lang.String dictKey,
                          java.lang.String keyValue,
                          java.lang.String keyFieldName,
                          java.lang.String valueFieldName)
```
    获取字典的配置项值，由指定的过滤字段和值进行匹配。如果过滤出多条记录，仅返回第一条的字段值
    
    参数:
    
    appId - 应用调用者AppId，该应用必须声明了关联com.actionsoft.apps.dict
    
    dictKey - 字典名，该字典的关键字
    
    keyValue - 过滤字段值
    
    keyFieldName - 过滤字段名
    
    valueFieldName - 取值字段名，如中文名叫CNNAME，系列扩展字段。见本API的FIELD_*常量
    
    返回:
    
    返回代码对应的值，取值由fieldName指定

接口 DictAPI

字段概要

方法概要

字段详细资料

FIELD_NO

FIELD_CNNAME

FIELD_ENNAME

FIELD_BIG5NAME

FIELD_EXTTEXT1

FIELD_EXTTEXT2

FIELD_EXTTEXT3

FIELD_EXTTEXT4

FIELD_EXTTEXT5

FIELD_EXTTEXT6

FIELD_EXTTEXT7

FIELD_EXTTEXT8

FIELD_EXTTEXT9

FIELD_EXTTEXT10

FIELD_EXTINT1

FIELD_EXTINT2

FIELD_EXTINT3

FIELD_EXTINT4

FIELD_EXTINT5

FIELD_EXTDOUBLE1

FIELD_EXTDOUBLE2

FIELD_EXTDOUBLE3

FIELD_EXTDATE1

FIELD_EXTDATE2

FIELD_ISACTIVE

FIELD_PNO

FIELD_ISLEAF

方法详细资料

queryValue

queryValues

getValue

getValue

getValue