lumis.doui.source.field

Interface ITabularSourceField

All Superinterfaces:

ISourceField

All Known Subinterfaces:

ITableSourceField

All Known Implementing Classes:

BaseTableSourceField, BaseTabularSourceField, CategorizationSourceField, ChannelTableSourceField, CommentContentLocaleField, DocumentSourceField, ExperimentalGenericTableSourceField, FileSizeField, FileTableSourceField, GenericTableSourceField, GroupConfigurationButtonField, GroupTypeConfigurationButtonField, LocaleMetaDataSourceField, MediaSourceField, MetaDataSourceField, PageTableSourceField, ParentContentSourceField, SingleColumnTableSourceField, TagSourceField, UserField, VersionActiveField, WorkflowAssignedToSourceField

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

The interface for a TabularSource field.

Since:

4.0.4

Version:

$Revision: 23035 $ $Date: 2019-08-05 19:55:10 +0000 (Mon, 05 Aug 2019) $

Method Summary

Modifier and Type	Method and Description
void	convertRowToFieldData(ISourceData originalRow, ISourceData sourceRow) Converts a row read from the data provider to this source field type.
boolean	isPosition() Returns a boolean indicating if this field is a position field.
boolean	isPrimaryKey() Returns a boolean indicating if this field is a primary key.
boolean	isSortable() Returns whether this field may be used to sort a query.

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

addDocumentFields, addDocumentTypeFields, getConverter, getDataType, getDefaultControlDefinition, getDefaultInputControlDefinition, getDefaultValue, getDefaultViewControlDefinition, getDefinitionNode, getId, getMaximumValue, getMinimumValue, getName, getValueClass, init, isDisplay, isExternalData, isGetData, isIntroduction, isIntroductionImage, isKeywords, isParentId, isPrimaryName, isPublishStartDate, isReadOnly, isRequired, isRequiredWhenVisible, isSearchable, postAdd, postDelete, postUpdate, preAdd, preDelete, preUpdate

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

isPosition

boolean isPosition()

Returns a boolean indicating if this field is a position field.

Returns:

true if this field is a position field, false otherwise.

Since:

10.3.0

isSortable

boolean isSortable()

Returns whether this field may be used to sort a query.

Returns:

true if this field may be used for sorting, false otherwise.

Since:

9.0.0

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