Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE


HTML Table
idclassservoy sReturnTypes
Table Row (tr)
styleheight: 30px;
Table Head (th)
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
JSFoundset
Span
classsWordList
JSColumn
Span
classsWordList
JSDataSet
Span
classsWordList
JSFoundSetUpdater
Span
classsWordList
JSTable
Span
classsWordList
JSRecord
Span
classsWordList
SQL_ACTION_TYPES

id
HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#nullColumnValidatorEnabled
Enable/disable the default null validator for non null columns, makes it possible todo the checks later on when saving, when for example autosave is disabled.

id
HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#acquireLock(foundset, record_index, [lock_name])
Request lock(s) for a foundset, can be a normal or related foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#addTableFilterParam(server_name, table_name, dataprovider, operator, value, [filter_name])
Adds a filter to all the foundsets based on a table.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#addTrackingInfo(columnName, value)
Add tracking info used in the log table.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#commitTransaction()
Returns true if a transaction is committed; rollback if commit fails.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#commitTransaction(saveFirst)
Returns true if a transaction is committed; rollback if commit fails.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundset
Table Cell (td)
#convertFoundSet(foundset, related)
Creates a foundset that combines all the records of the specified one-to-many relation seen from the given parent/primary foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
#convertToDataSet(array/ids_string/foundset, [array_with_dataprovider_names])
Converts the argument to a JSDataSet, possible use in controller.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#copyMatchingColumns(src_record, dest_record, [overwrite/array_of_names_not_overwritten])
Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows)
Performs a sql query on the specified server, saves the the result in a datasource.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
#createEmptyDataSet(row_count, columnCount/array_with_column_names)
Returns an empty dataset object.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#dataSourceExists(datasource)
Check wether a data source exists.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#getAutoSave()
Returns true or false if autosave is enabled or disabled.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
#getDataSetByQuery(server_name, sql_query, arguments, max_returned_rows)
Performs a sql query on the specified server, returns the result in a dataset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getDataSourceServerName(dataSource)
Returns the server name from the datasource, or null if not a database datasource.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getDataSourceTableName(dataSource)
Returns the table name from the datasource, or null if not a database datasource.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getDatabaseProductName(serverName)
Returns the database product name as supplied by the driver for a server.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord[]
Table Cell (td)
#getEditedRecords()
Returns an array of edited records with outstanding (unsaved) data.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord[]
Table Cell (td)
#getEditedRecords(foundset)
Returns an array of edited records with outstanding (unsaved) data.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord[]
Table Cell (td)
#getFailedRecords()
Returns an array of records that fail after a save.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRecord[]
Table Cell (td)
#getFailedRecords(foundset)
Returns an array of records that fail after a save.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundset
Table Cell (td)
#getFoundSet(dataSource)
Returns a foundset object for a specified datasource or server and tablename.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundset
Table Cell (td)
#getFoundSet(serverName, tableName)
Returns a foundset object for a specified datasource or server and tablename.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getFoundSetCount(foundset)
Returns the total number of records in a foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSFoundSetUpdater
Table Cell (td)
#getFoundSetUpdater(foundset)
Returns a JSFoundsetUpdater object that can be used to update all or a specific number of rows in the specified foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#getNextSequence(dataSource|serverName, [tableName], columnName)
Gets the next sequence for a column which has a sequence defined in its column dataprovider properties.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getSQL(foundset)
Returns the internal SQL which defines the specified (related)foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getSQL(foundset, includeFilters)
Returns the internal SQL which defines the specified (related)foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[]
Table Cell (td)
#getSQLParameters(foundset)
Returns the internal SQL parameters, as an array, that are used to define the specified (related)foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[]
Table Cell (td)
#getSQLParameters(foundset, includeFilters)
Returns the internal SQL parameters, as an array, that are used to define the specified (related)foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
#getServerNames()
Returns an array with all the server names used in the solution.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSTable
Table Cell (td)
#getTable(foundset/record/datasource, [table_name])
Returns the JSTable object from which more info can be obtained (like columns).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getTableCount(dataSource)
Returns the total number of records(rows) in a table.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[][]
Table Cell (td)
#getTableFilterParams(server_name, [filter_name])
Returns a two dimensional array object containing the table filter information currently applied to the servers tables.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
#getTableNames(serverName)
Returns an array of all table names for a specified server.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
#getViewNames(serverName)
Returns an array of all view names for a specified server.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#hasLocks([lock_name])
Returns true if the current client has any or the specified lock(s) acquired.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#hasNewRecords(foundset/record, [foundset_index])
Returns true if the argument (foundSet / record) has at least one row that was not yet saved in the database.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#hasRecordChanges(foundset/record, [foundset_index])
Returns true if the specified foundset, on a specific index or in any of its records, or the specified record has changes.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#hasRecords(foundset/record, [qualifiedRelationString])
Returns true if the (related)foundset exists and has records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#hasTransaction()
Returns true if there is an transaction active for this client.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#mergeRecords(source_record, combined_destination_record, [columnnamesarray_to_copy])
Merge records from the same foundset, updates entire datamodel (via foreign type on columns) with destination
record pk, deletes source record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#recalculate(foundsetOrRecord)
Can be used to recalculate a specified record or all rows in the specified foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#refreshRecordFromDatabase(foundset, index)
Flushes the client data cache and requeries the data for a record (based on the record index) in a foundset or all records in the foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#releaseAllLocks([lock_name])
Release all current locks the client has (optionally limited to named locks).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeTableFilterParam(serverName, filterName)
Removes a previously defined table filter.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#rollbackEditedRecords([foundset/record])
Rolls back in memory edited records that are outstanding (not saved).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#rollbackTransaction()
Rollback a transaction started by databaseManager.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#rollbackTransaction(rollbackEdited)
Rollback a transaction started by databaseManager.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#saveData([record/foundset])
Saves all outstanding (unsaved) data and exits the current record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#setAutoSave(autoSave)
Set autosave, if false then no saves will happen by the ui (not including deletes!).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setCreateEmptyFormFoundsets()
Turnoff the initial form foundset record loading, set this in the solution open method.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#startTransaction()
Start a database transaction.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#switchServer(sourceName, destinationName)
Switches a named server to another named server with the same datamodel (recommended to be used in an onOpen method for a solution).

...