Servoy 5.2.x Documentation
Child pages
  • JSFoundset

Versions Compared

Old Version 8

changes.mady.by.user Andrei Costache

Saved on

compared with

New Version Current

changes.mady.by.user Andrei Costache

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

A JSFoundset is a scriptable object, it contains record objects defined by its SQL. It does lazy load the PKs and records.
Each foundset has its own record set and selected index

HTML Table
idclassservoy sSummery
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summery
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#multiSelect
Get or set the multiSelect flag of the foundset.

id
HTML Table
classservoy sSummery
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summery
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#addFoundSetFilterParam(dataprovider, operator, value)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#addFoundSetFilterParam(dataprovider, operator, value, [name])
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#clear()
Clear the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#deleteAllRecords()
Delete all records in foundset, resulting in empty foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#deleteRecord([index/record])
Delete current/parameter record or the record under the given index.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundset
Table Cell (td)
#duplicateFoundSet()
Get a duplicate of the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#duplicateRecord([index], [location], [changeSelection])
Duplicate current record or record at index in the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#find()
Set the foundset in find mode.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getCurrentSort()
Get the current sort columns.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#getDataProviderValue(dataProviderID)
Get a value based on a dataprovider name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getDataSource()
Get the datasource used.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[][]
Table Cell (td)
#getFoundSetFilterParams()
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[][]
Table Cell (td)
#getFoundSetFilterParams([filterName])
Get the list of previously defined foundset filters.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord
Table Cell (td)
#getRecord(index)
Get the record object at the index.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getRecordIndex(record)
Get the record index.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getRelationName()
Gets the relation name (null if not a related foundset).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getSelectedIndex()
Get the current record index of the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number[]
Table Cell (td)
#getSelectedIndexes()
Get the selected records indexes.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord
Table Cell (td)
#getSelectedRecord()
Get the selected record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord[]
Table Cell (td)
#getSelectedRecords()
Get the selected records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getSize()
Get the number of records in this foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#invertRecords()
Invert the foundset against all rows of the current table.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#isInFind()
Check if this foundset is in find mode.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#loadAllRecords()
Loads all accessible records from the datasource into the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#loadOmittedRecords()
Loads the records that are currently omitted as a foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#loadRecords([input], [queryArgumentsArray])
Load records with primary key (dataset/number/uuid) or query.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#newRecord([location], [changeSelection])
Create a new record in the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#omitRecord([index])
Omit current record or the record under the given index, to be shown with loadOmittedRecords.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#relookup([index])
Perform a relookup for the current record or 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.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeFoundSetFilterParam(name)
Remove a named foundset filter.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#search([clearLastResults], [reduceSearch])
Perform a search and show the results.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#selectRecord(pkid1, [pkid2], [pkidn])
Select the record based on pk data.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setDataProviderValue(dataProviderID, value)
Set a value based on a dataprovider name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setSelectedIndex(index)
Set the current record index.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setSelectedIndexes(indexes)
Set the selected records indexes.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#sort(sortString, [defer])
Sorts the foundset based on the given sort string.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundset
Table Cell (td)
#unrelate()
Create a new unrelated foundset that is a copy of the current foundset.

...