ResponseObject (Java SDK API Reference for AWS PaaS)

java.lang.Object
- com.actionsoft.bpms.commons.mvc.view.ResponseObject

```
public final class ResponseObject
extends java.lang.Object
```
AWS通用数据对象封装，用于响应请求的处理结果

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ERROR` 错误状态
`static java.lang.String`	`INFO` 提示
`static java.lang.String`	`SUCCESS` 成功状态
`static java.lang.String`	`WARNING` 警告状态

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`ResponseObject`	`addArray()` 该方法仅用于向前台返回json数组的场景。
`ResponseObject`	`addObject()` 该方法仅用于向前台返回json数组的场景。
`boolean`	`containsKey(java.lang.String key)` data结构中是否包含指定的key
`ResponseObject`	`end()` 该方法仅用于向前台返回json数组的场景。
`ResponseObject`	`err()` 标记为错误状态
`ResponseObject`	`err(java.lang.String msg)` 设置状态为错误，并附加信息给调用者
`ResponseObject`	`err(java.lang.Throwable t)`
`ResponseObject`	`errorCode(java.lang.String errorCode)` 标记API错误码。
`java.lang.Object`	`get(java.lang.String key)` 从data里获取put到ResponseObject的对象
`java.lang.Object`	`getData()`
`<T> T`	`getData(java.lang.Class<T> t)`
`java.lang.String`	`getErrorCode()` 获得API错误码。
`java.lang.String`	`getMsg()` 获得附加的消息内容
`ResponseObject`	`info()` 标记为错误状态
`ResponseObject`	`info(java.lang.String msg)` 设置状态为提醒，并附加信息给调用者
`boolean`	`isErr()` 检查状态是否为出错
`boolean`	`isOk()` 检查状态是否为成功
`boolean`	`isWarn()` 检查状态是否为警告
`ResponseObject`	`msg(java.lang.String msg)` 将信息放入msg属性
`static ResponseObject`	`newErrResponse()` 构造一个状态标记为错误的对象结构
`static ResponseObject`	`newErrResponse(java.lang.String msg)` 构造一个状态标记为错误的对象结构，并附加信息给调用者
`static ResponseObject`	`newOkResponse()` 构造一个状态标记为成功的对象结构
`static ResponseObject`	`newOkResponse(java.lang.String msg)` 构造一个状态标记为成功的对象结构，并附加信息给调用者
`static ResponseObject`	`newWarnResponse()` 构造一个状态标记为警告的对象结构
`static ResponseObject`	`newWarnResponse(java.lang.String msg)` 构造一个状态标记为警告的对象结构，并附加信息给调用者
`ResponseObject`	`ok()` 标记为成功状态
`ResponseObject`	`ok(java.lang.String msg)` 设置状态为成功，并附加信息给调用者
`static ResponseObject`	`parse(java.lang.String str)` 通过json串反向构造一个ResponseObject
`ResponseObject`	`put(java.util.Map<java.lang.String,java.lang.Object> map)` 为data批量放入对象
`ResponseObject`	`put(java.lang.String key, java.lang.Object value)` 为data的放入一个对象
`void`	`setData(java.lang.Object data)` 仅用于兼容老版本ResponseObject的复杂数据生成方法。
`java.lang.String`	`toDataString()` 仅将ResponseObject的data对象转换成JSON串
`net.sf.json.JSONObject`	`toJsonObject()` 已过时。内部临时使用（2018年10月补丁后该方法删除），新API见toJSONObject
`JSONObject`	`toJSONObject()` 将ResponseObject转换成JSON对象
`java.lang.String`	`toString()` 将ResponseObject转换成JSON串
`java.lang.String`	`toXML()` 将ResponseObject转换成XML文档
`ResponseObject`	`warn()` 标记为警告状态
`ResponseObject`	`warn(java.lang.String msg)` 设置状态为警告，并附加信息给调用者

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - SUCCESS
```
public static final java.lang.String SUCCESS
```
    成功状态
    
    另请参阅:
    
    常量字段值
  - WARNING
```
public static final java.lang.String WARNING
```
    警告状态
    
    另请参阅:
    
    常量字段值
  - ERROR
```
public static final java.lang.String ERROR
```
    错误状态
    
    另请参阅:
    
    常量字段值
  - INFO
```
public static final java.lang.String INFO
```
    提示
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - errorCode
```
public ResponseObject errorCode(java.lang.String errorCode)
```
    标记API错误码。适用于有异常捕获时，为调用者提供异常错误码
    
    参数:
    
    errorCode - 错误码
    
    另请参阅:
    
    (400-800)
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    获得API错误码。适用于有异常捕获时，为调用者提供异常错误码
  - newOkResponse
```
public static ResponseObject newOkResponse()
```
    构造一个状态标记为成功的对象结构
    
    另请参阅:
    
    SUCCESS
  - newOkResponse
```
public static ResponseObject newOkResponse(java.lang.String msg)
```
    构造一个状态标记为成功的对象结构，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
    
    另请参阅:
    
    SUCCESS
  - newWarnResponse
```
public static ResponseObject newWarnResponse()
```
    构造一个状态标记为警告的对象结构
    
    另请参阅:
    
    WARNING
  - newWarnResponse
```
public static ResponseObject newWarnResponse(java.lang.String msg)
```
    构造一个状态标记为警告的对象结构，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
    
    另请参阅:
    
    WARNING
  - newErrResponse
```
public static ResponseObject newErrResponse()
```
    构造一个状态标记为错误的对象结构
    
    另请参阅:
    
    ERROR
  - newErrResponse
```
public static ResponseObject newErrResponse(java.lang.String msg)
```
    构造一个状态标记为错误的对象结构，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
    
    另请参阅:
    
    ERROR
  - parse
```
public static ResponseObject parse(java.lang.String str)
```
    通过json串反向构造一个ResponseObject
    
    参数:
    
    str - ResponseObject的json串
  - ok
```
public ResponseObject ok()
```
    标记为成功状态
    
    另请参阅:
    
    SUCCESS
  - warn
```
public ResponseObject warn()
```
    标记为警告状态
    
    另请参阅:
    
    WARNING
  - err
```
public ResponseObject err()
```
    标记为错误状态
    
    另请参阅:
    
    ERROR
  - info
```
public ResponseObject info()
```
    标记为错误状态
    
    另请参阅:
    
    INFO
  - isOk
```
public boolean isOk()
```
    检查状态是否为成功
    
    另请参阅:
    
    SUCCESS
  - isWarn
```
public boolean isWarn()
```
    检查状态是否为警告
    
    另请参阅:
    
    WARNING
  - isErr
```
public boolean isErr()
```
    检查状态是否为出错
    
    另请参阅:
    
    ERROR
  - getMsg
```
public java.lang.String getMsg()
```
    获得附加的消息内容
  - ok
```
public ResponseObject ok(java.lang.String msg)
```
    设置状态为成功，并附加信息给调用者
  - warn
```
public ResponseObject warn(java.lang.String msg)
```
    设置状态为警告，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
  - err
```
public ResponseObject err(java.lang.String msg)
```
    设置状态为错误，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
  - err
```
public ResponseObject err(java.lang.Throwable t)
```
  - info
```
public ResponseObject info(java.lang.String msg)
```
    设置状态为提醒，并附加信息给调用者
    
    参数:
    
    msg - 附加的信息
  - msg
```
public ResponseObject msg(java.lang.String msg)
```
    将信息放入msg属性
    
    参数:
    
    msg - 信息
  - get
```
public java.lang.Object get(java.lang.String key)
```
    从data里获取put到ResponseObject的对象
    
    参数:
    
    key - 键值
    
    返回:
    
    一个Java Object，该对象的类型对应于put操作
  - containsKey
```
public boolean containsKey(java.lang.String key)
```
    data结构中是否包含指定的key
    
    参数:
    
    key - 键值
    
    返回:
    
    包含返回true
  - put
```
public ResponseObject put(java.lang.String key,
                          java.lang.Object value)
```
    为data的放入一个对象
    
    参数:
    
    key - 键值
    
    value - 一个Java Object，该对象的类型对应于get操作
  - put
```
public ResponseObject put(java.util.Map<java.lang.String,java.lang.Object> map)
```
    为data批量放入对象
    
    参数:
    
    map - 将kv值放入
  - addObject
```
public ResponseObject addObject()
```
    该方法仅用于向前台返回json数组的场景。新增一个json对象，可能是向返回给前台的json数组中增加，也可能是返回给前台的json数组中的某个json数组
  - addArray
```
public ResponseObject addArray()
```
    该方法仅用于向前台返回json数组的场景。向返回给前台的json数组中增加数组
  - end
```
public ResponseObject end()
```
    该方法仅用于向前台返回json数组的场景。从当前json数组中跳出到返回给前台的json数组
  - setData
```
public void setData(java.lang.Object data)
```
    仅用于兼容老版本ResponseObject的复杂数据生成方法。直接给底层数据赋值
    
    参数:
    
    data - 内部data
  - getData
```
public java.lang.Object getData()
```
  - getData
```
public <T> T getData(java.lang.Class<T> t)
```
  - toString
```
public java.lang.String toString()
```
    将ResponseObject转换成JSON串
    
    覆盖:
    
    toString 在类中 java.lang.Object
  - toJsonObject
```
public net.sf.json.JSONObject toJsonObject()
```
    已过时。内部临时使用（2018年10月补丁后该方法删除），新API见toJSONObject
    
    将ResponseObject转换成JSON对象
  - toJSONObject
```
public JSONObject toJSONObject()
```
    将ResponseObject转换成JSON对象
  - toDataString
```
public java.lang.String toDataString()
```
    仅将ResponseObject的data对象转换成JSON串
    
    另请参阅:
    
    put(String, Object)
  - toXML
```
public java.lang.String toXML()
```
    将ResponseObject转换成XML文档

类 ResponseObject

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SUCCESS

WARNING

ERROR

INFO

方法详细资料

errorCode

getErrorCode

newOkResponse

newOkResponse

newWarnResponse

newWarnResponse

newErrResponse

newErrResponse

parse

ok

warn

err

info

isOk

isWarn

isErr

getMsg

ok

warn

err

err

info

msg

get

containsKey

put

put

addObject

addArray

end

setData

getData

getData

toString

toJsonObject

toJSONObject

toDataString

toXML