Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
JSColumn
Table Cell (td)
getColumn(name)
Returns a JSColumn for the named column (or column dataproviderID).
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getColumnNames()
Returns an array containing the names of all table columns.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDataSource()
Returns the table data source uri.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getQuotedSQLName()
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getRowIdentifierColumnNames()
Returns an array containing the names of the identifier (PK) column(s).
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getSQLName()
Returns the table name.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getServerName()
Returns the Servoy server name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isMetadataTable()
Returns whether table was flagged as metadata table.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetColumn-String
Table Row (tr)
idname
Table Cell (td)

getColumn

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSColumn
Span
stylefont-weight: bold;
getColumn
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a JSColumn for the named column (or column dataproviderID).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - The name of the column to return the value from.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSColumn - JSColumn column.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var jsColumn = jsTable.getColumn('campaign_name')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetColumnNames
Table Row (tr)
idname
Table Cell (td)

getColumnNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getColumnNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an array containing the names of all table columns.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - String array of column names.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDataSource
Table Row (tr)
idname
Table Cell (td)

getDataSource

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDataSource
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the table data source uri.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - String datasource uri.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var dataSource = jsTable.getDataSource()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetQuotedSQLName
Table Row (tr)
idname
Table Cell (td)

getQuotedSQLName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getQuotedSQLName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - String table name, quoted if needed.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//use with the raw SQL plugin:
//if the table name contains characters that are illegal in sql, the table name will be quoted
var jsTable = databaseManager.getTable('udm', 'campaigns')
var quotedTableName = jsTable.getQuotedSQLName()
plugins.rawSQL.executeSQL('udm',  quotedTableName,  'select * from ' + quotedTableName + ' where is_active = ?', [1])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRowIdentifierColumnNames
Table Row (tr)
idname
Table Cell (td)

getRowIdentifierColumnNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getRowIdentifierColumnNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an array containing the names of the identifier (PK) column(s).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - String array of row identifier column names.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSQLName
Table Row (tr)
idname
Table Cell (td)

getSQLName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getSQLName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the table name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - String table name.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetServerName
Table Row (tr)
idname
Table Cell (td)

getServerName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getServerName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the Servoy server name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - String server name.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idisMetadataTable
Table Row (tr)
idname
Table Cell (td)

isMetadataTable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isMetadataTable
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns whether table was flagged as metadata table.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - boolean is metadata
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jsTable = databaseManager.getTable('udm', 'campaigns')
var isMetaDataTable = jsTable.isMetadataTable()
Table Row (tr)
classlastDetailRow
Table Cell (td)