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

Class InstanceListColumn

java.lang.Object

com.aquima.interactions.framework.container.instance.list.config.impl.InstanceListColumn

All Implemented Interfaces:

IListColumn, IInstanceListColumn, Serializable

public class InstanceListColumn
extends Object
implements IInstanceListColumn

Column definition for the InstanceList implementation.

Since:

9.3

Author:

T. Middeldorp, G. der Kinderen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InstanceListColumn(String containmentName)
InstanceListColumn(String containmentName, int columnIndex)
InstanceListColumn(String containmentName, int columnIndex, DataType dataType)

Method Summary

Modifier and Type	Method	Description
String[]	getButtonActions()	This method returns the button actions for a button column.
String	getButtonEvent()	This method returns the button event for a button column.
String	getButtonName()	This method return the button name of a button that should trigger the start task event.
int	getColumnIndex()	Returns the index of this column.
String	getContainmentName()	Retrieves the name of the containment.
DataType	getDataType()	Returns the datatype of the column
IExpression	getFilterExpression()	This method returns the optional filter expression.
ConditionOperator	getFilterOperator()	This method returns the optional filter operator.
String	getHeaderTextItem()	This method returns the header text item used for this column.
String	getMaskCallName()	This method return the optional mask that should be applied to this columns value.
BooleanValue	getSortAscending()	This method returns if the column is used for sorting and the sort direction.
ICondition	getVisibleCondition()	This method returns the optional condition determining if the column should be displayed.
void	setSortAscending(BooleanValue sortAscending)
void	setVisibleCondition(ICondition visibleCondition)

Methods inherited from class java.lang.Object

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

Constructor Details

InstanceListColumn

public InstanceListColumn(String containmentName)

InstanceListColumn

public InstanceListColumn(String containmentName,
 int columnIndex)

InstanceListColumn

public InstanceListColumn(String containmentName,
 int columnIndex,
 DataType dataType)

Method Details

getHeaderTextItem

public String getHeaderTextItem()

Description copied from interface: IListColumn

This method returns the header text item used for this column.

Specified by:

getHeaderTextItem in interface IListColumn

Returns:

The name of the text item, may be null.

getSortAscending

public BooleanValue getSortAscending()

Description copied from interface: IListColumn

This method returns if the column is used for sorting and the sort direction.

• unknown: no sorting
• true: sort ascending
• false: sort descending

Specified by:

getSortAscending in interface IListColumn

Returns:

Indicator if this column is used for sorting, may be null for columns that only contain a button.

setSortAscending

public void setSortAscending(BooleanValue sortAscending)

getMaskCallName

public String getMaskCallName()

Description copied from interface: IListColumn

This method return the optional mask that should be applied to this columns value.

Specified by:

getMaskCallName in interface IListColumn

Returns:

The mask call name, optional, may be null.

getButtonName

public String getButtonName()

Description copied from interface: IListColumn

This method return the button name of a button that should trigger the start task event.

Specified by:

getButtonName in interface IListColumn

Returns:

The button name, may be null when this column does not contain a start task button.

getButtonEvent

public String getButtonEvent()

Description copied from interface: IListColumn

This method returns the button event for a button column.

Specified by:

getButtonEvent in interface IListColumn

Returns:

The button event, may be null.

getButtonActions

public String[] getButtonActions()

Description copied from interface: IListColumn

This method returns the button actions for a button column.

Specified by:

getButtonActions in interface IListColumn

Returns:

The button actions, may be null.

getVisibleCondition

public ICondition getVisibleCondition()

Description copied from interface: IListColumn

This method returns the optional condition determining if the column should be displayed.

Specified by:

getVisibleCondition in interface IListColumn

Returns:

The visibility condition of the column, may be null.

setVisibleCondition

public void setVisibleCondition(ICondition visibleCondition)

getFilterOperator

public ConditionOperator getFilterOperator()

Description copied from interface: IListColumn

This method returns the optional filter operator.

Specified by:

getFilterOperator in interface IListColumn

Returns:

The filter operator of the column, may be null.

getFilterExpression

public IExpression getFilterExpression()

Description copied from interface: IListColumn

This method returns the optional filter expression. The result of the expression is compared with the value of the cell. When the values differ, the complete row is discarded.

Specified by:

getFilterExpression in interface IListColumn

Returns:

The filter expression of the column, may be null.

getContainmentName

public String getContainmentName()

Description copied from interface: IInstanceListColumn

Retrieves the name of the containment.

Specified by:

getContainmentName in interface IInstanceListColumn

Returns:

name of the containment (never null)

getColumnIndex

public int getColumnIndex()

Description copied from interface: IListColumn

Returns the index of this column. The first column in the list has index 0.

Specified by:

getColumnIndex in interface IListColumn

Returns:

the index of this column

getDataType

public DataType getDataType()

Description copied from interface: IListColumn

Returns the datatype of the column

Specified by:

getDataType in interface IListColumn

Returns:

DataType}