lumis.doui.table.field
Interface ITableSourceField

All Superinterfaces:

ISourceField, ITabularSourceField

All Known Implementing Classes:

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

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

A TableSource field. Adds query manipulation methods to the source field.

Since:

4.0.4

Method Summary

Object	getAssignedValue(QueryBase queryBase) Returns the value assigned as this field's value in the given query.
QueryField	getDisplayQueryField(QueryBase queryBase) Returns the query field to be used for display purposes for this field.
List<QueryAssignment>	getQueryAssignments(QueryInsert queryInsert, IParameters parameters) Returns a list of query assignments to be used in the given query insert.
List<QueryAssignment>	getQueryAssignments(QueryUpdate queryUpdate, IParameters parameters) Returns a list of query assignments to be used in the given query update.
IQueryFilter	getQueryFilter(QueryBase queryBase, TableSourceFilter filter) Returns a query filter for this field.
List<QuerySortOrder>	getQuerySortOrders(QueryBase queryBase, String direction) Returns a list of sort orders to be applied when it is to be ordered by this field.
TableSourceFieldMapping	getTableMapping(QueryBase queryBase) Returns the table mapping for this field.

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

convertRowToFieldData, isPrimaryKey, isSearchable

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

getTableMapping

TableSourceFieldMapping getTableMapping(QueryBase queryBase)
                                        throws PortalException

Returns the table mapping for this field. This specifies how the field data is accessed.

Parameters:

queryBase - the query the mapping will be used.

Returns:

the field table mapping.

Throws:

PortalException

Since:

4.0.4

getQueryFilter

IQueryFilter getQueryFilter(QueryBase queryBase,
                            TableSourceFilter filter)
                            throws PortalException

Returns a query filter for this field.

Parameters:

queryBase - the query where the filter will be applied to.

filter - the filter definition.

Returns:

the query filter.

Throws:

PortalException

Since:

4.0.4

getQuerySortOrders

List<QuerySortOrder> getQuerySortOrders(QueryBase queryBase,
                                        String direction)
                                        throws PortalException

Returns a list of sort orders to be applied when it is to be ordered by this field.

Parameters:

queryBase - the query where the sort orders will be applied to.

direction - the direction this field is to be sorted.

Returns:

a list of sort orders, never null. May be an empty list if this field is not sortable.

Throws:

PortalException

Since:

4.0.4

getDisplayQueryField

QueryField getDisplayQueryField(QueryBase queryBase)
                                throws PortalException

Returns the query field to be used for display purposes for this field. This should be used only when it is needed at the query layer. Otherwise use the field's converter or the value render if it is lumis.util.IRenderable.

Parameters:

queryBase - the query base the query field will be used in.

Returns:

the query field.

Throws:

PortalException

Since:

4.0.4

getQueryAssignments

List<QueryAssignment> getQueryAssignments(QueryInsert queryInsert,
                                          IParameters parameters)
                                          throws PortalException

Returns a list of query assignments to be used in the given query insert.

Parameters:

queryInsert - the query insert.

parameters - the parameters with the values to be used.

Returns:

the list of query assignments, never null.

Throws:

PortalException

Since:

4.0.4

getQueryAssignments

List<QueryAssignment> getQueryAssignments(QueryUpdate queryUpdate,
                                          IParameters parameters)
                                          throws PortalException

Returns a list of query assignments to be used in the given query update.

Parameters:

queryInsert - the query update.

parameters - the parameters with the values to be used.

Returns:

the list of query assignments, never null.

Throws:

PortalException

Since:

4.0.4

getAssignedValue

Object getAssignedValue(QueryBase queryBase)
                        throws PortalException

Returns the value assigned as this field's value in the given query.

Parameters:

queryBase - the query.

Returns:

the value assigned as this field's value.

Throws:

PortalException

Since:

4.0.4