de.tif.jacob.core.definition
Interface ITableField

All Superinterfaces:

INamedObjectDefinition

public interface ITableField
extends INamedObjectDefinition

This interface represents the definition of a field within a data source table.

Method Summary

java.lang.String	getDBName() Returns the database name, i.e. the name of the respective database column, of the table field.
int	getFieldIndex() Returns the column field index of this table field.
java.lang.String	getLabel() Returns the label of this table field.
IKey	getMatchingForeignKey() Convenient method to determine whether the given field is part of a foreign key.
ITableDefinition	getTableDefinition() Returns the table definition of this table field.
FieldType	getType() Returns the type of this table field.
boolean	isEnabledForHistory() Checks whether this table field is enabled for history, i.e. changing the field value should be logged in the change history of the corresponding data table record.
boolean	isPrimary() Convenient method to determine whether the given field belongs to the primary key of the corresponding table.
boolean	isReadOnly() Checks whether this table field is readonly or not.
boolean	isRequired() Checks whether this table field is required or not.

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getName, getProperty

Method Detail

getDBName

java.lang.String getDBName()

Returns the database name, i.e. the name of the respective database column, of the table field.

Returns:

the database name

getLabel

java.lang.String getLabel()

Returns the label of this table field.

Note: The label could be internationalized, if the label starts with a '%' character. In this case the label is interpreted as a key to the respective application resource bundles for internationalization.

Returns:

the label of the table field

getFieldIndex

int getFieldIndex()

Returns the column field index of this table field.

Returns:

the column field index

getTableDefinition

ITableDefinition getTableDefinition()

Returns the table definition of this table field.

Returns:

the table definition

isRequired

boolean isRequired()

Checks whether this table field is required or not. The value of a required table should never be null or to be more precise, a table record with empty required table field value could not be committed to the data source.

Returns:

true if required, otherwise false

isReadOnly

boolean isReadOnly()

Checks whether this table field is readonly or not. A readonly table field could (by default) not be explicitly set nor changed by user interaction. Nevertheless, it could be implicitly modified by means of jACOB hooks.

Returns:

true if readonly, otherwise false

getType

FieldType getType()

Returns the type of this table field.

Note that this method is currently for internal use only!

Returns:

the table field type

isEnabledForHistory

boolean isEnabledForHistory()

Checks whether this table field is enabled for history, i.e. changing the field value should be logged in the change history of the corresponding data table record.

Returns:

true if enabled for history, otherwise false

getMatchingForeignKey

IKey getMatchingForeignKey()

Convenient method to determine whether the given field is part of a foreign key.

Returns:

the foreign key this table field is part of or null if no such foreign key exists.

isPrimary

boolean isPrimary()

Convenient method to determine whether the given field belongs to the primary key of the corresponding table.

Returns:

true field is part of the primary key, otherwise false