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

List of all members.

Public Member Functions

abstract< T > T getValue (IContext context, String columnName)
abstract< T > T getValue (IContext context, int columnIndex)
abstract< T > T getValue (IContext context, IDataColumnSchema dataColumnSchema)
abstract boolean hasColumn (String columnName)
abstract< T > T getPrimaryKeyValue ()
int getColumnIndex (String columnName)
abstract IDataTableSchema getSchema ()
abstract String getSpecificTableName ()
abstract void setSpecificTableName (String subjectName)
abstract boolean hasReadAccess (int columnIndex)
abstract boolean hasWriteAccess (int columnIndex)
Collection< MetaObjectAccess > getMetaObjectAccessList ()
IDataTable getDataTable ()

Detailed Description

A DataRow represents a row in a DataTable


Member Function Documentation

int com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getColumnIndex ( String  columnName)

Returns the internal index for a column This method is only provided for performance reasons. When looking up the value, as well as read and write permissions on a column, first use this function to determine the index value. After that, use calls which ask for the index instead of the column name.

Parameters:
columnName
Returns:
the internal index for a column
IDataTable com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getDataTable ( )
Collection<MetaObjectAccess> com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getMetaObjectAccessList ( )

Returns the total collection of MetaObjectAccess objects for this row.

Returns:
the total collection of MetaObjectAccess objects for this row.
abstract <T> T com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getPrimaryKeyValue ( ) [pure virtual]
Returns:
returns the generated GUID for this row based on the database id of this row, the name of the object type this row represents and the datastorecode
abstract IDataTableSchema com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getSchema ( ) [pure virtual]

Returns the schema of the table of this row.

Returns:
the schema of the table of this row
abstract String com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getSpecificTableName ( ) [pure virtual]

Only for internal use.

Returns:
abstract <T> T com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getValue ( IContext  context,
String  columnName 
) [pure virtual]

Returns the value of the column with the specified name in this row.

Parameters:
contextthe context.
columnNamename of the column from which the value must be returned.
Returns:
the value of the specified column in this row.
Exceptions:
IllegalArgumentExceptionwhen the columnName does not exist in this Row.
abstract <T> T com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getValue ( IContext  context,
int  columnIndex 
) [pure virtual]

Returns the value of the column with the specified index in this row.

Parameters:
contextthe context.
columnIndexindex of the column from which the value must be returned.
Returns:
the value of the specified column in this row.
Exceptions:
IndexOutOfBoundsExceptionwhen the index exceeds the count of columns of this row.
abstract <T> T com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.getValue ( IContext  context,
IDataColumnSchema  dataColumnSchema 
) [pure virtual]

Returns the value of the column with the index of the specified schema in this row. This method is identical in function to getValue(dataColumnSchema.getIndex()).

The returned value can be a primitive object or another DataTable object. When in the original request simply attributes of metaobjects were requested, the returned values will be of the primitive Java type corresponding to the type of the attribute. When aggregate functions are combined with simple attributes, this will also be the case. However, when more complex OQL expressions are used, it isn't always predictable which type the returned values will have. It depends on the expression type and the database type.

Parameters:
contextthe context
dataColumnSchemaschema of the column from which the value must be returned
Returns:
the value of the specified column in this row
abstract boolean com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.hasColumn ( String  columnName) [pure virtual]

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
abstract boolean com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.hasReadAccess ( int  columnIndex) [pure virtual]

Returns whether the user which has retrieved the data, has read access to the given column.

Parameters:
columnIndexthe column to retrieve the access information.
Returns:
whether the user which has retrieved the data, has read access to the given column
abstract boolean com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.hasWriteAccess ( int  columnIndex) [pure virtual]

Returns whether the user which has retrieved the data, has write access to the given column.

Parameters:
columnIndexthe column to retrieve the access information.
Returns:
whether the user which has retrieved the data, has write access to the given column
abstract void com.mendix.systemwideinterfaces.connectionbus.data.IDataRow.setSpecificTableName ( String  subjectName) [pure virtual]

Only for internal use.

Parameters:
subjectName

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