JSFoundSet

Boolean

deleteAllRecords

()

Delete all records in foundset, resulting in empty foundset.

Boolean – boolean true if all records could be deleted.

Boolean

deleteRecord

()

Delete currently selected record(s).
If the foundset is in multiselect mode, all selected records are deleted.

Boolean – boolean true if all records could be deleted.

Boolean

deleteRecord

(record)

Delete record from foundset.

{JSRecord} record – The record to delete from the foundset.

Boolean – boolean true if record could be deleted.

Boolean

deleteRecord

(index)

Delete record with the given index.

{Number} index – The index of the record to delete.

Boolean – boolean true if record could be deleted.

Boolean

find

()

Set the foundset in find mode. (Start a find request), use the "search" function to perform/exit the find.

Before going into find mode, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off), the foundset will not go into find mode.
Make sure the operator and the data (value) are part of the string passed to dataprovider (included inside a pair of quotation marks).
Note: always make sure to check the result of the find() method.

When in find mode, columns can be assigned string expressions (including operators) that are evaluated as:
General:
c1||c2 (condition1 or condition2)
c|format (apply format on condition like 'x|dd-MM-yyyy')
!c (not condition)
#c (modify condition, depends on column type)
^ (is null)
^= (is null or empty)
<x (less than value x)
>x (greater than value x)
<=x (less than or equals value x)
>=x (greater than or equals value x)
x...y (between values x and y, including values)
x (equals value x)

Number fields:
=x (equals value x)
^= (is null or zero)

Date fields:
#c (equals value x, entire day)
now (equals now, date and or time)
// (equals today)
today (equals today)

Text fields:
#c (case insensitive condition)
= x (equals a space and 'x')
^= (is null or empty)
%x% (contains 'x')
%x_y% (contains 'x' followed by any char and 'y')
% (contains char '%')
\_ (contains char '_')

Related columns can be assigned, they will result in related searches.
For example, "employees_to_department.location_id = headoffice" finds all employees in the specified location).

Searching on related aggregates is supported.
For example, "orders_to_details.total_amount = '>1000'" finds all orders with total order details amount more than 1000.

Arrays can be used for searching a number of values, this will result in an 'IN' condition that will be used in the search.
The values are not restricted to strings but can be any type that matches the column type.
For example, "record.department_id = [1, 33, 99]"

Boolean – true if the foundset is now in find mode, false otherwise.

JSRecord

getRecord

(index)

Get the record object at the index.

{Number} index – record index

JSRecord – Record record.

Number

getSelectedIndex

()

Get the current record index of the foundset.

Number – int current index (1-based)

JSRecord

getSelectedRecord

()

Get the selected record.

JSRecord – Record record.

Number

getSize

()

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

Number – int current size.

Boolean

isInFind

()

Check if this foundset is in find mode.

Boolean – boolean is in find mode.

Boolean

loadAllRecords

()

Loads all accessible records from the datasource into the foundset.
Filters on the foundset are applied.

Before loading the records, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off),
records will not be loaded,

Boolean – true if records are loaded, false otherwise.

Number

newRecord

()

Create a new record on top of the foundset and change selection to it. Returns -1 if the record can't be made.

Number – int index of new record.

Number

newRecord

(index, changeSelection)

Create a new record in the foundset. Returns -1 if the record can't be made.

{Number} index – the new record is added at specified index.
{Boolean} changeSelection – when true the selection is changed to the new record.

Number – int index of new record.

Number

search

()

Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Clear results from previous searches.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.

Number – the recordCount

void

setSelectedIndex

(index)

Set the current record index.

{Number} index – index to set (1-based)

void

void

sort

(recordComparisonFunction)

Sorts the foundset based on the given record comparator function.
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

{Function} recordComparisonFunction – record comparator function

void