JSFoundSet
Last updated
Was this helpful?
Last updated
Was this helpful?
FoundSet
serves as the data model for UI components or forms directly linked to a datasource, enabling data manipulation and validation. It supports common operations like sorting, query-based loading, and lazy loading, with features for relation handling and batch data management.
FoundSet
allows filtering, creating, duplicating, or deleting records with a robust API for data management. Filters can be applied via query builders or column-based conditions and can be removed dynamically. Sorting can be done with predefined strings, deferred execution, or custom comparator functions.
Developers can retrieve the current state of the foundset, including active filters, query parameters, and loaded record indices. FoundSet
's structure supports direct interaction with parent or related records, dynamic loading of omitted records, and navigation using indices or primary keys.
FoundSet
also offers functionality for find/search operations using SQL-like conditions. It integrates with server-side data sources for data synchronization, enabling a balance of client-side and server-side performance optimization.
Get all dataproviders of the foundset.
Get or set the multiSelect flag of the foundset.
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
void
Clear the foundset.
Create a new record on top of the foundset and change selection to it.
Create a new record in the foundset.
Create a new record in the foundset.
Create a new record in the foundset and change selection to it at specified index.
Create a new record in the foundset.
Create a table filter that can be applied to the foundset.
Delete all records in foundset, resulting in empty foundset.
Delete currently selected record(s).
Delete record from foundset.
Delete record with the given index.
Dispose a foundset from memory when foundset is no longer needed.
Get a duplicate of the foundset.
Duplicate current record, change selection to new record, place on top.
Duplicate selected record, change selection to new record.
Duplicate selected record.
Duplicate record at index in the foundset, change selection to new record, place on top.
Duplicate record at index in the foundset, change selection to new record.
Duplicate record at index in the foundset.
Duplicate record at index in the foundset, change selection to new record.
Duplicate record at index in the foundset.
Set the foundset in find mode.
Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
Iterates over the records of a foundset taking into account inserts and deletes that may happen at the same time.
Get the current sort columns.
Get a value based on a dataprovider name.
Get the datasource used.
Get the list of previously defined foundset filters.
Get a previously defined foundset filter, using its given name.
Get foundset name.
Returns a JSDataSet with the PKs omitted on this foundset If no PKs have been omitted, an empty JSDataSet will be returned
Gets the parent records when called on a related foundset.
Get the query that the foundset is currently using (as a clone; modifying this QBSelect will not automatically change the foundset).
Get the query that the foundset is currently using (as a clone; modifying this QBSelect will not automatically change the foundset).
Get the record object at the given index.
Get the loaded record based on its primary key values.
Get the record index.
Get the index of a record object inside a foundset
Gets the relation name (null if not a related foundset).
Returns the internal SQL of the JSFoundset.
Returns the internal SQL of the JSFoundset.
Returns the parameters for the internal SQL of the QBSelect.
Returns the parameters for the internal SQL of the QBSelect.
Get the current record index of the foundset.
Get the indexes of the selected records.
Get the selected record.
Get the selected records.
Get the number of records in this foundset.
Check wether the foundset has any conditions from a previous find action.
void
Invert the foundset against all rows of the current table.
Returns a boolean if this foundset is in a cleared state (has the clear condition that is added by a clear() call)
Check if the foundset was disposed.
Check if this foundset is in find mode.
Loads all accessible records from the datasource into the foundset.
Loads the records that are currently omitted as a foundset.
Reloads all last (related) records again, if, for example, after search in tabpanel.
Copies foundset data from another foundset.
Loads a primary key dataset, will remove related sort.
Loads records into form foundset based on a query builder object (also known as 'Form by query').
Loads a single record by primary key, will remove related sort.
Loads a single record by primary key, will remove related sort.
Loads records into form foundset based on a query (also known as 'Form by query').
Loads records into form foundset based on a query (also known as 'Form by query').
Create a new record on top of the foundset and change selection to it.
Create a new record in the foundset and change selection to it.
Create a new record in the foundset.
Create a new record in the foundset and change selection to it.
Create a new record in the foundset.
Omit selected record(s) (add it to omit records list), to be shown with loadOmittedRecords.
Omit record sent as parameter (add it to omit records list), to be shown with loadOmittedRecords.
Omit record under the given index (add it to omit records list), to be shown with loadOmittedRecords.
void
Reloads all last records again with the filters applied.
void
Perform a relookup for the currently selected records Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
void
Perform a relookup for the record under the given index Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
Remove a named foundset filter.
void
Reverts outstanding (not saved) in memory changes from edited records of this foundset.
Saves all outstanding (unsaved) data of this foundset and exits the current record.
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Select the record based on pk data.
void
Set a value based on a dataprovider name.
Set multiple foundset filters at the same time.
void
Set the current record index.
void
Set the selected records indexes.
void
Sorts the foundset based on the given sort string.
void
Sorts the foundset based on the given sort string.
void
Sorts the foundset based on the given record comparator function.
Create a new unrelated foundset that is a copy of the current foundset.
Get all dataproviders of the foundset.
Sample
Get or set the multiSelect flag of the foundset.
Sample
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Filters on tables touched in the query will not be applied to the query filter. For example, when a table filter exists on the order_details table, a query filter with a join from orders to order_details will be applied to the foundset, but the filter condition on the orders_details table will not be included.
Use clear(), reloadWithFilters(), loadRecords() or loadAllRecords() to make the filter effective. Multiple filters can be added to the same dataprovider, they will all be applied.
Parameters
Sample
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Filters on tables touched in the query will not be applied to the query filter. For example, when a table filter exists on the order_details table, a query filter with a join from orders to order_details will be applied to the foundset, but the filter condition on the orders_details table will not be included.
Use clear(), reloadWithFilters(), loadRecords() or loadAllRecords() to make the filter effective. The filter is removed again using removeFoundSetFilterParam(name).
The table of the query has to be the same as the foundset table.
Parameters
Sample
Add a filter parameter that is permanent per user session to limit a specified foundset of records. Use clear(), reloadWithFilters(), loadRecords() or loadAllRecords() to make the filter effective. Multiple filters can be added to the same dataprovider, they will all be applied.
Parameters
Sample
Add a filter parameter that is permanent per user session to limit a specified foundset of records. Use clear(), reloadWithFilters(), loadRecords() or loadAllRecords() to make the filter effective. The filter is removed again using removeFoundSetFilterParam(name).
Parameters
Sample
Clear the foundset.
This will set a special condition in the query that makes the query not return any results.
But if new Records are added to this foundset, then those records become the query pk set. So it will then behave the same as loadRecord(pkset) of a pkset of those new records.
You can query for this state in the isCleared() call so you can call loadRecords() to remove that cleared state if needed.
Returns: void
Sample
Create a new record on top of the foundset and change selection to it. Returns the new record or null if record was not created.
Sample
Create a new record in the foundset. Returns the new record or null if the record can't be made.
Parameters
Sample
Create a new record in the foundset. Returns the new record or null if the record can't be made.
Parameters
Sample
Create a new record in the foundset and change selection to it at specified index. Returns the new record or null if the record can't be made.
Parameters
Sample
Create a new record in the foundset. Returns the new record or null if the record can't be made.
Parameters
Sample
Create a table filter that can be applied to the foundset. Multiple filters can be applied at the same time using foundset.setTableFilters().
Parameters
Sample
Delete all records in foundset, resulting in empty foundset.
Sample
Delete currently selected record(s). If the foundset is in multiselect mode, all selected records are deleted.
Sample
Delete record from foundset.
Parameters
Sample
Delete record with the given index.
Parameters
Sample
Dispose a foundset from memory when foundset is no longer needed. Should be used to destroy separate foundsets (is an optimization for memory management). A related foundset or a foundset which is linked to visible forms/components cannot be disposed. Returns whether foundset was disposed or not.
Sample
Get a duplicate of the foundset. This is a full copy of the foundset (cached pks,records, relation, filters, search criteria, omitted records, selection).
Sample
Duplicate current record, change selection to new record, place on top.
Sample
Duplicate selected record, change selection to new record.
Parameters
Sample
Duplicate selected record.
Parameters
Sample
Duplicate record at index in the foundset, change selection to new record, place on top.
Parameters
Sample
Duplicate record at index in the foundset, change selection to new record.
Parameters
Sample
Duplicate record at index in the foundset.
Parameters
Sample
Duplicate record at index in the foundset, change selection to new record.
Parameters
Sample
Duplicate record at index in the foundset.
Parameters
Sample
Sample
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 iteration over the foundset will be stopped.
Parameters
Sample
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 iteration over the foundset will be stopped.
Parameters
Sample
Get the current sort columns.
Sample
Get a value based on a dataprovider name.
Parameters
Sample
Get the datasource used. The datasource is an url that describes the data source.
Sample
Get the list of previously defined foundset filters.
For column-based table filters, a row of 5 fields per filter are returned. The "columns" of a row from this array are: tablename, dataprovider, operator, value, filtername
For query-based filters, a row of 2 fields per filter are returned. The "columns" of a row from this array are: query, filtername
Sample
Get a previously defined foundset filter, using its given name. The result is an array of: [ tableName, dataprovider, operator, value, name ]
Parameters
Sample
Get foundset name. If foundset is not named foundset or related foundset will return null.
Sample
Returns a JSDataSet with the PKs omitted on this foundset If no PKs have been omitted, an empty JSDataSet will be returned
Sample
Gets the parent records when called on a related foundset. (empty array if not a related foundset) Depending on the cardinality of the relation, this method returns either 1 or more records. This can be useful when creating a new record in an empty related foundset and some data from the parent record(s) is needed.
Be aware that if datasources.xxx.getFoundset() is called multiple times on the same datasource it creates multiple foundset instances then the related foundset can have multiple references to the same parent record but in different foundsets. (different instances of the record for the same row in the database) In that case, this method will return the record from the first foundset.
Sample
Get the query that the foundset is currently using (as a clone; modifying this QBSelect will not automatically change the foundset). When the foundset is in find mode, the find conditions are included in the resulting query. So the query that would be used when just calling search() (or search(true,true)) is returned. Note that foundset filters are optionally included and table filters are not included in the query.
Sample
Get the query that the foundset is currently using (as a clone; modifying this QBSelect will not automatically change the foundset). When the foundset is in find mode, the find conditions are included in the resulting query. So the query that would be used when just calling search() (or search(true,true)) is returned. Note that foundset filters are optionally included and table filters are not included in the query.
Parameters
Sample
Get the record object at the given index. Argument "index" is 1 based (so first record is 1).
Parameters
Sample
Get the loaded record based on its primary key values.
This will only return a record that is already loaded in this foundset; this will not try to load anything from the database.
Parameters
Sample
Get the record index. Will return -1 if the record can't be found.
Parameters
Sample
Get the index of a record object inside a foundset
Parameters
Gets the relation name (null if not a related foundset).
Sample
Returns the internal SQL of the JSFoundset. Optionally, the foundset and table filter params can be excluded in the sql (includeFilters=false).
Sample
Returns the internal SQL of the JSFoundset. Optionally, the foundset and table filter params can be excluded in the sql (includeFilters=false).
Parameters
Sample
Returns the parameters for the internal SQL of the QBSelect. Table filters are on by default.
Sample
Returns the parameters for the internal SQL of the QBSelect. Table filters are on by default.
Parameters
Sample
Get the current record index of the foundset.
Sample
Get the indexes of the selected records. When the foundset is in multiSelect mode (see property multiSelect), a selection can consist of more than one index.
Sample
Get the selected record.
Sample
Get the selected records. When the foundset is in multiSelect mode (see property multiSelect), selection can be a more than 1 record.
Sample
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.
Sample
Check wether the foundset has any conditions from a previous find action.
Sample
Invert the foundset against all rows of the current table. All records that are not in the foundset will become the current foundset.
Returns: void
Sample
Returns a boolean if this foundset is in a cleared state (has the clear condition that is added by a clear() call)
Check if the foundset was disposed.
When the foundset.dispose() method was called successfully, a foundset can no longer be used.
Sample
Check if this foundset is in find mode.
Sample
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,
Sample
Loads the records that are currently omitted as a foundset.
Before loading the omitted 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), omitted records will not be loaded,
Sample
Reloads all last (related) records again, if, for example, after search in tabpanel. When in find mode, this will reload the records from before the find() call.
Sample
Copies foundset data from another foundset. This will alter the foundset state to the state of the foundset that is given. If you really just want to use the given foundset on the form itself, then you need to use controller.loadRecords(foundset) that will change the instance of the foundset that is used for this form. Not just update an existing forms foundset.
If you copy over a relation into this foundset, then this foundset will not be a related foundset, it will not automatically update its state of records are updated or added that belong to that relation. It will only be a snapshot of that related foundsets state.
Foundset filter params are copied over from the original/source foundset and are merged with the existing filters on this foundset. So if the original foundset had filters and the given foundset has filters then the resulting foundset will have all the filters of both, If you don't want this and you really want only the state of the given foundset, use controller.loadRecords(fs) instead of foundset.loadRecords(fs)
Parameters
Sample
Loads a primary key dataset, will remove related sort. Tries to preserve selection based on primary key, otherwise first record is selected.
Parameters
Sample
Loads records into form foundset based on a query builder object (also known as 'Form by query'). When the foundset is in find mode, the find states are discarded, the foundset will go out of find mode and the foundset will be loaded using the query. If the foundset is related, the relation-condition will be added to the query. Tries to preserve selection based on primary key, otherwise first record is selected.
The query of the QBSelect that is given is added as a "search" condition to the existing base query of the foundset. This does mean that loadAllRecords() will revert this, because that will clear the search condition and go back to the base query of the foundset. The same holds true for clear() that will also remove the search condition, and, because of that, the given query will also be removed.
If you want to create more a "view" on your database that will always be kept by this foundset, so loadAllRecords() (with our withou first calliing clear()) will always revert back to this set of data (and you can also search inside this data with find/search or adding another query on top of it. Then have a look at datasources.db.server.table.getFoundset(query) because that will generate a foundset with the given query as the base query.
Parameters
Sample
Loads a single record by primary key, will remove related sort.
NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().
Parameters
Sample
Loads a single record by primary key, will remove related sort.
NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().
Parameters
Sample
Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select. If the foundset is related this function is not allowed. Tries to preserve selection based on primary key, otherwise first record is selected. see foundset.loadRecords(QBSelect). When possible, the foundset will be loaded with the given query. This is not always possible because the foundset needs to manipulate the query when adding conditions and joins. In that case the query will be wrapped: select pk from tab where pk = (queryString) The result is the same, except for the ordering in the queryString which will be ignored. The query will be wrapped when one of the following is true:
you have no order-by clause
you have no from keyword
your query is not fully qualified on the main table
you have a group-by, having, join or union keyword
Parameters
Sample
Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select. If the foundset is related this function is not allowed. Tries to preserve selection based on primary key, otherwise first record is selected. see foundset.loadRecords(QBSelect). When possible, the foundset will be loaded with the given query. This is not always possible because the foundset needs to manipulate the query when adding conditions and joins. In that case the query will be wrapped: select pk from tab where pk = (queryString) The result is the same, except for the ordering in the queryString which will be ignored. The query will be wrapped when one of the following is true:
you have no order-by clause
you have no from keyword
your query is not fully qualified on the main table
you have a group-by, having, join or union keyword
Parameters
Sample
Create a new record on top of the foundset and change selection to it. Returns -1 if the record can't be made.
Sample
Create a new record in the foundset and change selection to it. Returns -1 if the record can't be made.
Parameters
Sample
Create a new record in the foundset. Returns -1 if the record can't be made.
Parameters
Sample
Create a new record in the foundset and change selection to it. Returns -1 if the record can't be made.
Parameters
Sample
Create a new record in the foundset. Returns -1 if the record can't be made.
Parameters
Sample
Omit selected record(s) (add it to omit records list), to be shown with loadOmittedRecords. This operation returns false only when foundset is in bad state (table not accessible or not having a valid selected record) or the record is in an edit state and can't be saved (autosave is false).
Note: The omitted records list is discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invertRecords()
Sample
Omit record sent as parameter (add it to omit records list), to be shown with loadOmittedRecords. This operation returns false only when foundset is in bad state (table not accessible or not having a valid selected record) or the record is in an edit state and can't be saved (autosave is false) or record not present in foundset.
Note: The omitted records list is discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invertRecords()
Parameters
Sample
Omit record under the given index (add it to omit records list), to be shown with loadOmittedRecords. If index is null it behaves just like omitRecord(). This operation returns false when index is invalid (should be between 1 and foundset size) or foundset is in bad state (its table not accessible) or the record is in an edit state and can't be saved (autosave is false). Any retrievable record can be omitted.
Note: The omitted records list is discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invertRecords()
Parameters
Sample
Reloads all last records again with the filters applied.
Returns: void
Sample
Perform a relookup for the currently selected records Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
Returns: void
Sample
Perform a relookup for the record under the given index Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
Parameters
Returns: void
Sample
Remove a named foundset filter. Use clear(), reloadWithFilters(), loadRecords() or loadAllRecords() to make the filter effective.
Parameters
Sample
Reverts outstanding (not saved) in memory changes from edited records of this foundset. Best used in combination with the function databaseManager.setAutoSave()
Returns: void
Saves all outstanding (unsaved) data of this foundset and exits the current record.
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.
Sample
Start the database search and use the results, returns the number of records, make sure you did "find" function first. Reduce 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.
Parameters
Sample
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.
Parameters
Sample
Select the record based on pk data. Note that if the foundset has not loaded the record with the pk, selectrecord will fail.
In case of a table with a composite key, the pk sequence must match the alphabetical ordering of the pk column names.
Parameters
Sample
Set a value based on a dataprovider name.
Parameters
Returns: void
Sample
Set multiple foundset filters at the same time. After all filters have been applied / updated, the foundset will re reloaded immediately with the new filters applied.
The filters that have been applied with the same filter name will be removed and replaced with the new set of filters (which may be empty).
Parameters
Sample
Set the current record index.
Parameters
Returns: void
Sample
Set the selected records indexes.
Parameters
Returns: void
Sample
Sorts the foundset based on the given sort string. 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. TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
Parameters
Returns: void
Sample
Sorts the foundset based on the given sort string. 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. TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
Parameters
Returns: void
Sample
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
Returns: void
Sample
Create a new unrelated foundset that is a copy of the current foundset. If the current foundset is not related, no copy will made.
Sample
Type
Type True if the foundset is in multi-select mode; false otherwise.
query condition to filter on.
Returns: true if adding the filter succeeded, false otherwise.
query condition to filter on.
name String name, used to remove the filter again.
Returns: true if adding the filter succeeded, false otherwise.
dataprovider String column to filter on.
operator String operator: =, <, >, >=, <=, !=, (NOT) LIKE, (NOT) IN, (NOT) BETWEEN and IS (NOT) NULL optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null), prefix with "sql:" to allow the value to be interpreted as a custom query.
value Object filter value (for in array and between an array with 2 elements)
Returns: true if adding the filter succeeded, false otherwise.
dataprovider String column to filter on.
operator String operator: =, <, >, >=, <=, !=, (NOT) LIKE, (NOT) IN, (NOT) BETWEEN and IS (NOT) NULL optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null), prefix with "sql:" to allow the value to be interpreted as a custom query.
value Object filter value (for in array and between an array with 2 elements)
name String name, used to remove the filter again.
Returns: true if adding the filter succeeded, false otherwise.
Returns: the new record
onTop when true the new record is added as the topmost record.
Returns: the new record.
onTop when true the new record is added as the topmost record; when false the record is added to the end, if all records are loaded, otherwise it will be added to the top
changeSelection when true the selection is changed to the new record.
Returns: the new record.
index the new record is added at specified index (1-based).
Returns: the new record.
index the new record is added at specified index (1-based).
changeSelection when true the selection is changed to the new record.
Returns: the new record.
dataprovider A specified dataprovider column name.
operator One of "=, <, >, >=, <=, !=, LIKE, or IN" optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null), prefix with "sql:" to allow the value to be interpreted as a custom query.
value The specified filter value.
Returns: table filter or null when no filter could be created.
Returns: boolean true if all records could be deleted.
Returns: boolean true if all records could be deleted.
record The record to delete from the foundset.
Returns: boolean true if record could be deleted.
index The index of the record to delete.
Returns: boolean true if record could be deleted.
Returns: boolean foundset was disposed
Returns: foundset duplicate.
Returns: 0 if record was not created or the record index if it was created.
onTop when true the new record is added as the topmost record.
Returns: 0 if record was not created or the record index if it was created.
onTop when true the new record is added as the topmost record.
changeSelection when true the selection is changed to the duplicated record.
Returns: 0 if record was not created or the record index if it was created.
index The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
Returns: 0 if record was not created or the record index if it was created.
index The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
onTop when true the new record is added as the topmost record.
Returns: 0 if record was not created or the record index if it was created.
index The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
onTop when true the new record is added as the topmost record.
changeSelection when true the selection is changed to the duplicated record.
Returns: 0 if record was not created or the record index if it was created.
index The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
location the new record is added at specified index
Returns: 0 if record was not created or the record index if it was created.
index The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
location the new record is added at specified index
changeSelection when true the selection is changed to the duplicated record.
Returns: 0 if record was not created or the record index if it was created.
Returns: true if the foundset is now in find mode, false otherwise.
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: Object the return value of the callback
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.
thisObject What the this object should be in the callback function (default it is the foundset)
Returns: Object the return value of the callback
Returns: String sort columns
dataProviderID data provider name
Returns: Object value
Returns: String data source.
Returns: Array of filter definitions.
filterName name of the filter to retrieve.
Returns: Array of filter definitions.
Returns: name.
Returns: a JSDataSet
Returns: an array of records
Returns: query.
includeFilters include the foundset filters, default true.
Returns: query.
index record index (1 based).
Returns: Record record.
pk pk values as array
Returns: Record record.
record Record
Returns: int index.
record the records object
Returns: the index or -1 if not present (anymore)
Returns: String relation name when related.
Returns: String representing the sql of the JSFoundset.
includeFilters include the foundset and table filters [default true].
Returns: String representing the sql of the JSFoundset.
Returns: An Array with the sql parameter values.
includeFilters include the foundset and table filters [default true].
Returns: An Array with the sql parameter values.
Returns: int current index (1-based)
Returns: Array current indexes (1-based)
Returns: Record record.
Returns: Array current records.
Returns: int current size.
Returns: wether the foundset has find-conditions
Returns: boolean true if this foundset is cleared
Returns: True if the foundset has been disposed; false otherwise.
Returns: boolean is in find mode.
Returns: true if records are loaded, false otherwise.
Returns: true if records are loaded, false otherwise.
Returns: true if successful
foundset The foundset to load records from
Returns: true if successful
dataset pkdataset
Returns: true if successful
querybuilder the query builder
Returns: true if successful
uuidpk single-column pk value
Returns: true if successful
numberpk single-column pk value
Returns: true if successful
queryString select statement
Returns: true if successful
queryString select statement
argumentsArray arguments to query
Returns: true if successful
Returns: int index of new record.
onTop when true the new record is added as the topmost record.
Returns: int index of new record.
onTop when true the new record is added as the topmost record; when false the record is added to the end, if all records are loaded, otherwise it will be added to the top
changeSelection when true the selection is changed to the new record.
Returns: int index of new record.
index the new record is added at specified index.
Returns: int index of new record.
index the new record is added at specified index.
changeSelection when true the selection is changed to the new record.
Returns: int index of new record.
Returns: boolean true if all selected record(s) could be omitted.
record Record - The record to be omitted from the foundset.
Returns: boolean true if record could be omitted.
index The index of the record to omit, starting with 1 .
Returns: boolean true if all records could be omitted.
index record index (1-based)
name String filter name.
Returns: true if removing the filter succeeded, false otherwise.
Returns: true if the save was done without an error.
Returns: the recordCount
clearLastResults boolean, clear previous search, default true
Returns: the recordCount
clearLastResults boolean, clear previous search, default true
reduceSearch boolean, reduce (true) or extend (false) previous search results, default true
Returns: the recordCount
pkid1 primary key
pkid2 second primary key (in case of composite primary key)
pkidn nth primary key
Returns: true if succeeded.
dataProviderID data provider name
value value to set
filterName The name of the filter that should be set.
tableFilters list of filters to be applied.
Returns: true if the table filters could be applied.
index index to set (1-based)
indexes An array with indexes to set.
sortString the specified columns (and sort order)
sortString the specified columns (and sort order)
defer when true, the "sortString" will be just stored, without performing a query on the database (the actual sorting will be deferred until the next data loading action).
recordComparisonFunction record comparator function
Returns: FoundSet unrelated foundset.