Mendix Runtime
Documentation for the Mendix Runtime Environment API
com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema Interface Reference

List of all members.

Public Member Functions

boolean hasColumn (String columnName)
int getColumnCount ()
IDataColumnSchema getPrimaryKey ()
int getColumnIndex (String columnName)
abstract String getName ()
IDataColumnSchema getColumnSchema (int columnIndex)
IDataColumnSchema getColumnSchema (String columnName)
List<?extends IDataColumnSchemagetColumnSchemas ()

Detailed Description

A DataTableSchema describes the sctucture of a DataTable


Member Function Documentation

int com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getColumnCount ( )

Returns the number of columns a row contains.

Returns:
number of columns a row contains
int com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getColumnIndex ( String  columnName)

Returns the index of a columnName.

Parameters:
columnName
Returns:
the index of a columnName.
Exceptions:
ConnectionBusExceptionif the columnName does not exist
IDataColumnSchema com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getColumnSchema ( int  columnIndex)

Returns the schema of the column with the specified index.

Parameters:
columnIndexthe index the column
Returns:
the schema of the column
IDataColumnSchema com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getColumnSchema ( String  columnName)

Returns the schema of the column with the specified name.

Parameters:
columnNamethe name the column
Returns:
the schema of the column
List<? extends IDataColumnSchema> com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getColumnSchemas ( )

Returns the schemas of all columns.

Returns:
the schemas of all columns
abstract String com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getName ( ) [pure virtual]

Returns the name of the entity of the data in the datatable. However, specific rows can belong to a derived entity.

Returns:
returns the name of the entity.
IDataColumnSchema com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.getPrimaryKey ( )

Only for internal use.

boolean com.mendix.systemwideinterfaces.connectionbus.data.IDataTableSchema.hasColumn ( String  columnName)

Returns whether the column name is defined in the schema or not.

Parameters:
columnName
Returns:
true if and only if the column name is defined in the schema

The documentation for this interface was generated from the following file: