lumis.doui.source.field
Interface ITabularSourceField

All Superinterfaces:

ISourceField

All Known Subinterfaces:

ITableSourceField

All Known Implementing Classes:

BaseTableSourceField, BaseTabularSourceField, ChannelTableSourceField, CommentContentLocaleField, DocumentSourceField, FileSizeField, FileTableSourceField, GenericTableSourceField, GroupConfigurationButtonField, GroupTypeConfigurationButtonField, ImageSourceField, MetaDataSourceField, PageTableSourceField, ParentContentSourceField, SingleColumnTableSourceField, VersionActiveField, WorkflowAssignedToSourceField

@StableMinor(version="5.5",
             sinceVersion="4.0")
public interface ITabularSourceField
extends ISourceField

The interface for a TabularSource field.

Since:

4.0.4

Method Summary

void	convertRowToFieldData(ISourceData originalRow, ISourceData sourceRow) Converts a row read from the data provider to this source field type.
boolean	isPrimaryKey() Returns a boolean indicating if this field is a primary key.
boolean	isSearchable() Returns a boolean indicating if this field is searchable.

Methods inherited from interface lumis.doui.source.field.ISourceField

getConverter, getDataType, getDefaultControlDefinition, getDefaultInputControlDefinition, getDefaultValue, getDefaultViewControlDefinition, getDefinitionNode, getId, getMaximumValue, getMinimumValue, getName, getValueClass, init, isDisplay, isExternalData, isGetData, isIntroduction, isKeywords, isParentId, isPrimaryName, isReadOnly, isRequired, isRequiredWhenVisible

Method Detail

isPrimaryKey

boolean isPrimaryKey()

Returns a boolean indicating if this field is a primary key.

Returns:

true if this field is a primary key, false otherwise.

Since:

4.0.4

isSearchable

boolean isSearchable()

Returns a boolean indicating if this field is searchable.

Returns:

true if this field is a primary name, false otherwise.

Since:

4.0.6

convertRowToFieldData

void convertRowToFieldData(ISourceData originalRow,
                           ISourceData sourceRow)
                           throws PortalException

Converts a row read from the data provider to this source field type.

Parameters:

originalRow - a row containing the original data.

sourceRow - the row to be populated with this field's data.

Throws:

PortalException

Since:

4.0.4