API
Component

RestData ($UI/system/components/justep/data/restData)

使用范围:UI2

Contents

component RestData ($UI/system/components/justep/data/restData) extends Data

RestData,继承Data的所有属性和方法

Constructor Top

  RestData ()

Attributes Top

String className

对应的数据模型对象

String url

数据操作的url

Methods Top

void clearFilter ()
void clearOrderBy ()
void deleteAllData (DataConfirmParam options)
boolean deleteData (Array rows, DataConfirmParam options)
void loadAllPageData ()
void loadNextPageData ()
void loadPageData (integer pageIndex, DataConfirmParam options)
List newData (JSON options)
void refreshData (RefreshDataParam options)
Boolean saveAllData (Object options)
void saveData (Object options)
void setFilter (String name, String filters)
void setOrderBy (String col, String type)

Operations Top

void clearFilter ()
void clearOrderBy ()
void setFilter (String name, String filters)
void setOrderBy (String col, String type)

Events Top

void onSaveBatchReadyEvent ($UI/system/components/justep/data/data#SaveBatchReadyEvent event)

Constructor details Top

public RestData ()

RestData,继承Data的所有属性和方法

Attributes Detail Top

public String className

对应的数据模型对象

public String url

数据操作的url

Methods Detail Top

public void clearFilter ()

清除所有过滤

Return Value

void

public void clearOrderBy ()

清除所有排序

Return Value

void

public void deleteAllData (DataConfirmParam options)

删除data所有数据,感知directDeleteMode和confirmDelete属性设置

Parameters

DataConfirmParam options

删除参数
参数格式:

{ "confirm" : {boolean} - 删除确认提示,缺省使用属性confirmDelete }

Return Value

void

public boolean deleteData (Array rows, DataConfirmParam options)

Parameters

Array rows

行数组 缺省当前行 (Optional)

DataConfirmParam options

删除参数 (Optional)

Return Value

boolean

public void loadAllPageData ()

在分页状态加载所有数据

Return Value

void

public void loadNextPageData ()

加载下一页的数据,受offset、limit影响

Return Value

void

public void loadPageData (integer pageIndex, DataConfirmParam options)

分页模式下加载第N页数据

Parameters

integer pageIndex

[required]页索引

DataConfirmParam options

刷新参数
参数格式:

{ "confirm" : {boolean} - 刷新提示,缺省使用属性confirmRefresh }

Return Value

void

public List newData (JSON options)

数据新增方法,支持返回多行

Parameters

JSON options

新增参数 ,支持多行新增

Return Value

List

返回新增行的rows

public void refreshData (RefreshDataParam options)

业务数据刷新,会刺激从data级联刷新,当limit!=-1时取第一页数据,当limit=-1时取全部数据,当confirmRefresh=true并且数据是编辑或者新增状态时刷新数据时显示刷新确认提示框

Parameters

RefreshDataParam options

刷新参数
参数格式:

{ "append" : {boolean} - 增量刷新,不清除原有数据,默认:false, "confirm" : {boolean} - 刷新提示,缺省使用属性confirmRefresh }

Return Value

void

public Boolean saveAllData (Object options)

全部数据保存方法,向后端提交修改的所有修改新增数据

Parameters

Object options

参数
参数格式:

{ "onError" : {function} - 失败回调,function(event), event的格式: { "source" : {Data} - 组件的js对象, "errorType" : {String} - 'server', "errorNode" : {object} - 错误信息, "httpError" : {boolean} - 是否http请求失败, "httpState" : {String} - http请求返回码 } "onSuccess" : {function} - 成功回调,function(event), event的格式: { "source" : {Data} - 组件的js对象 } "ignoreInvalid" : {boolean} - 保存时忽略有效性校验,默认false }

Return Value

Boolean

public void saveData (Object options)

业务数据保存方法,向后端提交修改的数据

Parameters

Object options

参数
参数格式:

{ "ignoreInvalid" : {boolean} - 保存时忽略有效性校验,默认false }

Return Value

void

public void setFilter (String name, String filters)

设置过滤条件

Parameters

String name

过滤名称

String filters

过滤条件

Return Value

void

public void setOrderBy (String col, String type)

设置排序

Parameters

String col

String type

排序方式 OrderBy的类型0:DESC/1:ASC,为null时清空对应关系的排序

Return Value

void

Operations Detail Top

public void clearFilter ()

清除所有过滤

Return Value

void

public void clearOrderBy ()

清除所有排序

Return Value

void

public void setFilter (String name, String filters)

设置过滤条件

Parameters

String name

过滤名称

String filters

过滤条件

Return Value

void

public void setOrderBy (String col, String type)

设置排序

Parameters

String col

String type

排序方式

Return Value

void

Events Detail Top

public void onSaveBatchReadyEvent ($UI/system/components/justep/data/data#SaveBatchReadyEvent event)

[回调型事件]批保存准备

Parameters

$UI/system/components/justep/data/data#SaveBatchReadyEvent event


结构如下:

{ "source" : 组件的js对象, "usePatch" : 使用批提交 "options" : 保存时给入的参数 }

Return Value

void