Table

The Table interface represents a table defined in a form, integration service or workflow job.

Individual tables can be accessed via the Tables interface.

Further documentation.

Table Properties

SORT_DIRECTION_ASCENDING A constant for sort direction ascending for use with the sort() methods
SORT_DIRECTION_DESCENDING A constant for sort direction descending for use with the sort() methods

Table Functions

getColumns Table.getColumns( ) Returns an array of all columns in the table.
copyTable Table.copyTable( fromTable , removeExistingRows ) Optionally removes all existing rows and then copies rows from the table specified by fromTable.
getCurrentRow Table.getCurrentRow( ) Returns the row number for the table's current row.
setCurrentRow Table.setCurrentRow( row ) Sets the table's current row.
deleteRow Table.deleteRow( [row ] ) Deletes the specified row in the table.
fetchTable Table.fetchTable( [noUpdate ] ) Loads data into the table from the external resource specified as the backing resource, and sets the first row as the current row (see #getCurrentRow()).
findRow Table.findRow( column , value ) Returns the first row number with the specified column value, or -1 if no match is found.
findRows Table.findRows( parms ) Returns a row iterator object containing all rows that match the search criteria specified by parms.
getColumn Table.getColumn( columnName ) Returns the specified table column or null if the column does not exist.
getColumnValueOnRow Table.getColumnValueOnRow( column , row ) Returns an Object representing the value of the table cell at the specified column and row.
insertRow Table.insertRow( ) Inserts a new row into the table and sets this row as the current row of the table (see #getCurrentRow()).
isRowDeletedByUser Table.isRowDeletedByUser( [row ] ) Returns true if the specified row is marked as deleted by the user.
isRowEmpty Table.isRowEmpty( [row ] ) Returns true if the specified row is marked as empty.
isRowInserted Table.isRowInserted( [row ] ) Returns true if the specified row has been inserted.
isRowModified Table.isRowModified( [row ] ) Returns true if the specified row has been modified.
isRowSelected Table.isRowSelected( [row ] ) Returns true if the specified row is marked as selected.
loadFromJSON Table.loadFromJSON( jsonString ) Loads rows from a JSON string into the table.
replaceTable Table.replaceTable( fromTable ) Removes all existing rows and copies rows from the table specified by fromTable.
resetTable Table.resetTable( ) Removes all rows from the table and resets the current row (see #getCurrentRow()).
getRowCount Table.getRowCount( ) Returns the number of rows in the table.
setRowDeletedByUser Table.setRowDeletedByUser( deleted ) Sets the deleted by the user status for the current row (see #getCurrentRow()).
setRowEmpty Table.setRowEmpty( empty ) Sets the empty status for the current row (see #getCurrentRow()).
getRows Table.getRows( ) Returns a row iterator object that can be used to traverse all table rows
setRowSelected Table.setRowSelected( selected ) Sets the selected flag for the current row (see #getCurrentRow()).
setColumnValueOnRow Table.setColumnValueOnRow( column , row , value ) Sets a value for the table cell at the specified column and row.
setRowDeletedByUser Table.setRowDeletedByUser( row , deleted ) Sets the deleted by the user status for the specified row.
setRowEmpty Table.setRowEmpty( row , empty ) Sets the empty status for the specified row.
setRowSelected Table.setRowSelected( row , selected ) Sets the selected flag for the specified row.
sort Table.sort( columns [, directions ] ) Sorts the table rows using multiple columns.
sort Table.sort( column [, direction ] ) Sorts the table rows using the single column specified by column in the order specified by direction.
getSortColumns Table.getSortColumns( ) Returns an Array of all the columns that are currently sorted.
getSortDirections Table.getSortDirections( ) Returns an Array of all the directions that are currently sorted.
toJSON Table.toJSON( [excludeNullValues ] ) Returns a JSON string representing all rows in the table, this is the same as #toJSON() but additionally provides an option on how null values in table columns are handled.
updateTable Table.updateTable( ) Updates the external resource specified as the backing resource for the table with the table data, deleting, inserting, and updating rows as required.

Element Functions

getElementName Table.getElementName( ) Returns the element name
getElementType Table.getElementType( ) Returns the element type