Package com.aquima.interactions.framework.container.instance.list

Class InstanceListImpl

java.lang.Object

com.aquima.interactions.framework.container.list.ListImpl

com.aquima.interactions.framework.container.instance.list.InstanceListImpl

public class InstanceListImpl
extends ListImpl

Improved Instance selector plus implementation which provides paging, sorting and searching on top of the existing functionality.

Since:

9.3

Author:

T. Middeldorp, G. der Kinderen

See Also:

• InstanceList

Field Summary

Fields inherited from class com.aquima.interactions.framework.container.list.ListImpl

context, MESSAGE_SEARCH, numberOfVisibleColumns, PAGINATION

Constructor Summary

Constructors

Constructor	Description
InstanceListImpl(InstanceListParameters parameters, IContainerContext context, ContainerDefinition definition)

Method Summary

Modifier and Type	Method	Description
protected void	addBody(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration)
protected void	addFooter(Container container, ListState state, ListConfiguration configuration)
protected void	addHeader(Container container, ListState state, ListConfiguration configuration)	Adds a container before the tabular content.
protected void	addTableHeaders(TableBuilder tableBuilder, ListState state, ListConfiguration configuration)
protected void	addTableRows(TableBuilder tableBuilder, IListRowData[] rows)
protected ListRowDataComparator	createListRowDataComparator(List<Sorting> sorting)
protected Container	expand(Container container, ContainerDefinition definition)
protected String	getId()	Gets the identifier for this container implementation.
protected IEntityInstance[]	getInstances(IContainerContext context, InstanceListParameters parameters)
protected boolean	isValidDataType(IListColumn column, DataType dataType)	Verifies that a data type corresponds with the column definition.
protected void	postProcessTable(Container container, IListRowData[] rows)
protected IValue	processColumnValue(IListColumn listColumn, IListRowData listRow)	Retrieves the value at the intersection of a column and a row, for data that is to be used in search functionality.

Methods inherited from class com.aquima.interactions.framework.container.list.ListImpl

createSortButton, createTable, createText, createText, createValue, formatValue, getProcessEngine, initialize, processRows

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InstanceListImpl

public InstanceListImpl(InstanceListParameters parameters,
 IContainerContext context,
 ContainerDefinition definition)

Method Details

getId

protected String getId()

Description copied from class: ListImpl

Gets the identifier for this container implementation.

Overrides:

getId in class ListImpl

Returns:

Id, can be null.

expand

protected Container expand(Container container,
 ContainerDefinition definition)
                    throws Exception

Throws:

Exception

postProcessTable

protected void postProcessTable(Container container,
 IListRowData[] rows)

Overrides:

postProcessTable in class ListImpl

addBody

protected void addBody(Container container,
 IListRowData[] rows,
 ListState state,
 ListConfiguration configuration)
                throws Exception

Overrides:

addBody in class ListImpl

Throws:

Exception

addHeader

protected void addHeader(Container container,
 ListState state,
 ListConfiguration configuration)

Description copied from class: ListImpl

Adds a container before the tabular content. Includes search functionality.

Overrides:

addHeader in class ListImpl

Parameters:

container - the container

state - the state

configuration - the configuration

addFooter

protected void addFooter(Container container,
 ListState state,
 ListConfiguration configuration)

Overrides:

addFooter in class ListImpl

addTableHeaders

protected void addTableHeaders(TableBuilder tableBuilder,
 ListState state,
 ListConfiguration configuration)
                        throws Exception

Overrides:

addTableHeaders in class ListImpl

Throws:

Exception

addTableRows

protected void addTableRows(TableBuilder tableBuilder,
 IListRowData[] rows)
                     throws Exception

Specified by:

addTableRows in class ListImpl

Throws:

Exception

isValidDataType

protected boolean isValidDataType(IListColumn column,
 DataType dataType)

Description copied from class: ListImpl

Verifies that a data type corresponds with the column definition.

Specified by:

isValidDataType in class ListImpl

Parameters:

column - The column definition (cannot be null)

dataType - the type to verify (cannot be null)

Returns:

true when the column definition corresponds with the data type, false otherwise.

processColumnValue

protected IValue processColumnValue(IListColumn listColumn,
 IListRowData listRow)

Description copied from class: ListImpl

Retrieves the value at the intersection of a column and a row, for data that is to be used in search functionality.

Specified by:

processColumnValue in class ListImpl

Parameters:

listColumn - The column from which to obtain a value (cannot be null)

listRow - The row from which to obtain a value (cannot be null)

Returns:

a value, possibly null.

createListRowDataComparator

protected ListRowDataComparator createListRowDataComparator(List<Sorting> sorting)

Overrides:

createListRowDataComparator in class ListImpl

getInstances

protected IEntityInstance[] getInstances(IContainerContext context,
 InstanceListParameters parameters)