Skip to end of metadata
Go to start of metadata

Refresh page Jun 19, 2019 18:27



Supported Clients

SmartClient WebClient NGClient



Constants Summary
Number MONITOR_AGGREGATES Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for changes in columns (selected) of the given datasource in the query that can affect aggregates.
Number MONITOR_COLUMNS Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource.
Number MONITOR_DELETES Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for deletes on the given table/datasource.
Number MONITOR_DELETES_FOR_PRIMARY_TABLE Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for deletes on the given table/datasource which should be the primary/main table of this query.
Number MONITOR_INSERT Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for inserts on the given table/datasource.
Number MONITOR_JOIN_CONDITIONS Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource in the join statement Like order_lines.
Number MONITOR_WHERE_CONDITIONS Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource that are used in the where statement.



Property Summary
Boolean multiSelect Returns true if this foundset is in multiselect mode and false if it's in single-select mode.
void setMultiSelect Puts this foundset in multi-select or single-select mode.



Methods Summary
void enableDatabroadcastFor(queryTable) Databroadcast can be enabled per select table of a query, the select table can be the main QBSelect or on of it QBJoins By default this monitors only the column values that are in the result of the QBSelect, you can only enable this default monitoring for a table if for that table also the PK is selected in the results.
void enableDatabroadcastFor(queryTable, flags) Enable the databroadcast for a specific table of the QBSelect or QBJoin with flags for looking for join or where criteria or deletes/inserts.
Object forEach(callback) Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
Object forEach(callback, thisObject) Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
String getDataSource() Returns the datasource (view:name) for this ViewFoundSet.
QBSelect getQuery() Get the cloned query that created this ViewFoundSset (modifying this QBSelect will not change the foundset).
JSRecord getRecord(index) Get the ViewRecord object at the given index.
JSRecord getSelectedRecord()


Number getSize() Get the number of records in this viewfoundset.
void loadAllRecords() This will reload the current set of ViewRecords in this foundset, resetting the chunk size back to the start (default 200).
Number save() Saves all records in the view foundset that have changes.
Number save(record) Saved a specific record of this foundset.
void sort(recordComparisonFunction) Sorts the foundset based on the given record comparator function.



Constants Details

MONITOR_AGGREGATES

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for changes in columns (selected) of the given datasource in the query that can affect aggregates.
This means that when there are deletes, inserts or updates on columns selected from that datasource, a full re-query will happen - to refresh the aggregates.

IMPORTANT: in general, this flag should be set on (possible multiple) datasources from the query that have group by on their columns, and the columns don't contain the pk, or that have
the actual aggregates on their columns (because all those could influence the value of aggregates). For example (ignoring the fact that in a real-life situation these fields might not change),
a view foundset based on this query:

SELECT orders.customerid, orders.orderdate, SUM(order_details.unitprice) FROM orders
   LEFT OUTER JOIN order_details ON orders.orderid = order_details.orderid
   GROUP BY orders.customerid, orders.orderdate
	  ORDER BY orders.customerid asc, orders.orderdate desc

will want to enable databroadcast flag MONITOR_AGGREGATES on both "orders" (because if "orderdate" or "customerid" - that are used in GROUP BY - change/are corrected on a row, that row
could move from one group to the other, affecting the SUM(order_details.unitprice) for the groups involved) and "order_details" (because if "unitprice" changes/is corrected, the
aggregate will be affected).
But if the above query would also select the orders.odersid (and also group by that) then the orders row that you select for that sum will always be unique and only #MONITOR_COLUMNS
has to be done for those if needed.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_COLUMNS

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource.
This is used by default  if you just use enableDatabroadcastFor() without flags.  If you use the one with the flags you need to give this one if you just
want to listen to column changes that are in the result for a given datasource and pk.
This constants needs to have the pk's selected for the given datasource (should be in the results)

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_DELETES

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for deletes on the given table/datasource.
This will always result in a full query to detect changes whenever an delete  on that table happens.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_DELETES_FOR_PRIMARY_TABLE

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for deletes on the given table/datasource which should be the primary/main table of this query.
If a delete comes in for this table, then we will only remove the records from the ViewFoundSet that do have this primary key in its value. So no need to do a full query.
So this will only work if the query shows order_lines for the order_lines table, not for the products table that is joined to get the product_name.
Only 1 of the 2 monitors for deletes should be registered for a table/datasource.
This constants needs to have the pk's selected for the given datasource (should be in the results)

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_INSERT

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen for inserts on the given table/datasource.
This will always result in a full query to detect changes whenever an insert on that table happens.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_JOIN_CONDITIONS

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource in the join statement
Like order_lines.productid that has a join to orders and is displaying the productname.
If a change in such a join condition (like order_lines.productid in the sample above) is seen then the query will be fired again to detect changes.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


MONITOR_WHERE_CONDITIONS

Constant for the flags in #enableDatabroadcastFor(QBTableClause,int) to listen also for column changes of the given table/datasource that are used in the where statement.
Like order_lines.unit_price > 100. If a change is seen on that datasource on such a column used in the where a full query will be fired again to detect changes.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 




Property Details

multiSelect

Returns true if this foundset is in multiselect mode and false if it's in single-select mode.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


setMultiSelect

Puts this foundset in multi-select or single-select mode. If this foundset is shown in a form, this call can be
ignored as the form decides the foundset's multiselect.

Supported Clients

SmartClient,WebClient,NGClient

Sample

 




Methods Details

enableDatabroadcastFor(queryTable)

Databroadcast can be enabled per select table of a query, the select table can be the main QBSelect or on of it QBJoins
By default this monitors only the column values that are in the result of the QBSelect, you can only enable this default monitoring for a table if for that table also the PK is selected in the results.

you can use #enableDatabroadcastFor(QBTableClause,int) to specify what should be monitored more besides pure column values per pk.
Those have impact on performance because for the most part if we see a hit then a full query is done to see if there are changes.

Parameters

QBTableClause queryTable The QBSelect or QBJoin of a full query where this foundset should listen for data changes.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var select = datasources.db.example_data.order_details.createSelect();
 var join = select.joins.add("db:/example_data/products");
 join.on.add(select.columns.productid.eq(join.columns.productid));
 select.result.add(); // add columns of the select or join
 var vf = databaseManager.getViewFoundSet("myorders",select)
 vf.enableDatabroadcastFor(select);
 vf.enableDatabroadcastFor(join);


enableDatabroadcastFor(queryTable, flags)

Enable the databroadcast for a specific table of the QBSelect or QBJoin with  flags for looking for join or where criteria or deletes/inserts.
These  flags can be a performance hit because the query needs to be executed again to see if there are any changes.
For certain flags #MONITOR_COLUMNS and #MONITOR_DELETES_FOR_PRIMARY_TABLE the pk for that table must be in the results.

Parameters

QBTableClause queryTable The QBSelect or QBJoin of a full query where this foundset should listenn for data changes.
Number flags One or more of the ViewFoundSet.XXX flags added to each other.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var select = datasources.db.example_data.order_details.createSelect();
 var join = select.joins.add("db:/example_data/products");
 join.on.add(select.columns.productid.eq(join.columns.productid));
 select.result.add(); // add columns of the select or join
 var vf = databaseManager.getViewFoundSet("myorders",select)
 // monitor for the main table the join conditions (orders->product, when product id changes in the orders table) and requery the table on insert events, delete directly the record if a pk delete happens.
 vf.enableDatabroadcastFor(select,,ViewFoundSet.MONITOR_JOIN_CONDITIONS | ViewFoundSet.MONITOR_INSERT | ViewFoundSet.MONITOR_DELETES_FOR_PRIMARY_TABLE);
 vf.enableDatabroadcastFor(join);


forEach(callback)

Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
It will dynamically load all records in the foundset (using Servoy lazy loading mechanism). If callback function returns a non null value the traversal will be stopped and that value is returned.
If no value is returned all records of the foundset will be traversed. Foundset modifications( like sort, omit...) cannot be performed in the callback function.
If foundset is modified an exception will be thrown. This exception will also happen if a refresh happens because of a rollback call for records on this datasource when iterating.
When an exception is thrown from the callback function, the iteraion over the foundset will be stopped.

Parameters

Function callback The callback function to be called for each loaded record in the foundset. Can receive three parameters: the record to be processed, the index of the record in the foundset, and the foundset that is traversed.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

foundset.forEach(function(record,recordIndex,foundset) {
 	//handle the record here
 });


forEach(callback, thisObject)

Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
It will dynamically load all records in the foundset (using Servoy lazy loading mechanism). If callback function returns a non null value the traversal will be stopped and that value is returned.
If no value is returned all records of the foundset will be traversed. Foundset modifications( like sort, omit...) cannot be performed in the callback function.
If foundset is modified an exception will be thrown. This exception will also happen if a refresh happens because of a rollback call for records on this datasource when iterating.
When an exception is thrown from the callback function, the iteraion over the foundset will be stopped.

Parameters

Function callback The callback function to be called for each loaded record in the foundset. Can receive three parameters: the record to be processed, the index of the record in the foundset, and the foundset that is traversed.
Object thisObject What the this object should be in the callback function (default it is the foundset)

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

foundset.forEach(function(record,recordIndex,foundset) {
 	//handle the record here
 });


getDataSource()

Returns the datasource (view:name) for this ViewFoundSet.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

solutionModel.getForm("x").dataSource  = viewFoundSet.getDataSource();


getQuery()

Get the cloned query that created this ViewFoundSset (modifying this QBSelect will not change the foundset).
The ViewFoundSets main query can't be altered after creation; you need to make a new ViewFoundSet for that (it can have the same datasource name).

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var q = foundset.getQuery()
q.where.add(q.columns.x.eq(100))
var newVF = databaseManager.getViewFoundset("name", q);


getRecord(index)

Get the ViewRecord object at the given index.
Argument "index" is 1 based (so first record is 1).

Parameters

Number index record index (1 based).

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var record = %%prefix%%vfs.getRecord(index);


getSelectedRecord()


Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


getSize()

Get the number of records in this viewfoundset.
This is the number of records loaded, note that when looping over a foundset, size() may
increase as more records are loaded.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var nrRecords = %%prefix%%vfs.getSize()

// to loop over foundset, recalculate size for each record
for (var i = 1; i <= %%prefix%%foundset.getSize(); i++)
{
	var rec = %%prefix%%vfs.getRecord(i);
}


loadAllRecords()

This will reload the current set of ViewRecords in this foundset, resetting the chunk size back to the start (default 200).
All edited records will be discarded! So this can be seen as a full clean up of this ViewFoundSet.

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


save()

Saves all records in the view foundset that have changes.
You can only save columns from a table if the pks of that table are also selected by the view foundset's query.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


save(record)

Saved a specific record of this foundset.
You can only save columns from a table if also the pk is selected of that table

Parameters

JSRecord record ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 


sort(recordComparisonFunction)

Sorts the foundset based on the given record comparator function.
Tries to preserve selection based on primary key. If first record is selected or cannot select old record it will select first record after sort.
The comparator function is called to compare
two records, that are passed as arguments, and
it will return -1/0/1 if the first record is less/equal/greater
then the second record.

The function based sorting does not work with printing.
It is just a temporary in-memory sort.

NOTE: starting with 7.2 release this function doesn't save the data anymore

Parameters

Function recordComparisonFunction record comparator function

Supported Clients

SmartClient,WebClient,NGClient

Sample

%%prefix%%foundset.sort(mySortFunction);

function mySortFunction(r1, r2)
{
	var o = 0;
	if(r1.id < r2.id)
	{
		o = -1;
	}
	else if(r1.id > r2.id)
	{
		o = 1;
	}
	return o;
}


  • No labels