【深入理解TcaplusDB技术】删除列表所有数据接口说明——[List表]
摘要
实现删除表格中指定Key的列表中的所有数据。
示例代码
同步调用参见章节：[List表]删除列表所有数据示例代码。
异步调用参见章节：异步调用接口示例代码。
Request对象方法说明
注：如有未列出来的Request对象方法，即表示该方法在删除数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
void setCmd(int cmd) |
设置请求类型（指令）。cmd：请求类型，固定为TcaplusProtocolCsConstants.TCAPLUS_CMD_LIST_DELETEALL_REQ。 |
void setTableName(String tableName) |
设置目标表名。tableName：目标表名，不能为null。 |
Record addRecord() |
获取数据对象（Record），用于设置要删除的数据的Key，用户可以调用该对象的setKeyXXX方法设置各Key字段的值。 |
Request中的Record对象方法说明
注：如有未列出来的Record对象方法，即表示该方法在删除数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
void setVersion(int version) |
设置数据的版本号。version：如果设置为负数，表示当前数据不启动版本控制。 |
void setKeyByte(String fieldName, byte value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的byte类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyShort(String fieldName, short value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的short类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyInt(String fieldName, int value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的int类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyLong(String fieldName, long value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的long类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyFloat(String fieldName, float value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的float类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyDouble(String fieldName, double value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的double类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyString(String fieldName, String value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的String类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
void setKeyBlob(String fieldName, byte[] value) |
设置指定名称的Key字段的值。注意：当TDR表描述文件中定义的字段类型与Java的byte[]类型对应时，才可调用该方法设置字段值，否则服务端在处理请求时会参数错误。参见TDR表字段类型与Java类型对应关系。fieldName：字段名称，不可为null。value：字段的新值。 |
Response对象方法说明
注：如有未列出来的Response对象方法，即表示该方法在删除数据的场景下是无效的。
| 方法签名 | 方法说明 |
|---|---|
int getResult() |
获取删除数据请求的响应码。0表示操作成功。非0表示操作异常，参见响应码含义说明。 |
