Datalist Binder Plugin

Usages

The Datalist Binder Plugin is used to extend the methods for loading data into a Datalist in Joget. To create a functional Datalist Binder plugin, it must extend the org.joget.apps.datalist.model.DataListBinderDefault abstract class, which provides the necessary structure for handling data operations within a Datalist.

Abstract Class

org.joget.apps.datalist.model.DataListBinderDefault

• Under wflow-core module
• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
• Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
• A base abstract class to develop a Datalist Binder Plugin.

Constants

USERVIEW_KEY_SYNTAX

public static final String USERVIEW_KEY_SYNTAX = "#userviewKey#";
Not using by system. Can be use as a syntax to replace it with userview key value.

Abstract Methods

getColumns

public org.joget.apps.datalist.model.DataListColumn[] getColumns()
Columns meta returned by the binder. Field "name", "label" and "sortable" are needed by system.

getPrimaryKeyColumnName

public java.lang.String getPrimaryKeyColumnName()
The primary key / identifier column for the data

getData

public org.joget.apps.datalist.model.DataListCollection getData(org.joget.apps.datalist.model.DataList dataList, java.util.Map properties, org.joget.apps.datalist.model.DataListFilterQueryObject[] filterQueryObjects, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
The data rows returned by the binder based on the current filter.

getDataTotalRowCount

public int getDataTotalRowCount(org.joget.apps.datalist.model.DataList dataList, java.util.Map properties, org.joget.apps.datalist.model.DataListFilterQueryObject[] filterQueryObjects)
Total number of rows returned based on the current filter.

Overridable Methods

getColumnName

public java.lang.String getColumnName(java.lang.String name)
To get the actual column name.

processFilterQueryObjects

public org.joget.apps.datalist.model.DataListFilterQueryObject processFilterQueryObjects(org.joget.apps.datalist.model.DataListFilterQueryObject[] filterQueryObjects)
Construct filter conditions.

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• Guideline for Developing a Plugin
• How to develop an Amazon S3 Datalist Binder

Related Community Plugins

• Form Data Binder

org.joget.apps.datalist.lib.FormRowDataListBinder (wflow-core)