Package com.aquima.interactions.framework.container.caselist.config.impl

Class XmlCaseListParameters

java.lang.Object

com.aquima.interactions.framework.container.caselist.config.impl.XmlCaseListParameters

All Implemented Interfaces:

ICaseListParameters

public final class XmlCaseListParameters
extends Object
implements ICaseListParameters

This class contains the caselist configuration and is responsible for parsing the container parameters that are configured in Aquima Studio.

Since:

9.2

Author:

B. van de Ven

Method Summary

Modifier and Type	Method	Description
IAggregateDefinition	getCaseAggregate()
AttributeReference	getCaseIdTargetAttribute()	This method returns the optional target attribute for the caseId.
ICaseListColumn[]	getColumns()	This method returns the configured columns.
AttributeReference	getGroupByAttribute()	This method returns the boolean flag if the caselist should group all case attribute.
String	getNoResultTextItem()	This method returns the optional text to use when no results are found in the database.
IntegerValue	getPagingSize()	This method returns the optional number of cases that are shown per page, if set paging is enabled
static ICaseListParameters	parseParameters(IContainerContext context, IMetaModel caseModel)

Methods inherited from class java.lang.Object

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

Method Details

parseParameters

public static ICaseListParameters parseParameters(IContainerContext context,
 IMetaModel caseModel)

getColumns

public ICaseListColumn[] getColumns()

Description copied from interface: ICaseListParameters

This method returns the configured columns.

Specified by:

getColumns in interface ICaseListParameters

Returns:

The configured columns, never null.

getCaseIdTargetAttribute

public AttributeReference getCaseIdTargetAttribute()

Description copied from interface: ICaseListParameters

This method returns the optional target attribute for the caseId.

Specified by:

getCaseIdTargetAttribute in interface ICaseListParameters

Returns:

The attribute reference for the caseId, may be null.

getNoResultTextItem

public String getNoResultTextItem()

Description copied from interface: ICaseListParameters

This method returns the optional text to use when no results are found in the database.

Specified by:

getNoResultTextItem in interface ICaseListParameters

Returns:

The text item name, may be null.

getGroupByAttribute

public AttributeReference getGroupByAttribute()

Description copied from interface: ICaseListParameters

This method returns the boolean flag if the caselist should group all case attribute.

Specified by:

getGroupByAttribute in interface ICaseListParameters

Returns:

Boolean indicating if the caselist should group all tasks by case attribute.

getPagingSize

public IntegerValue getPagingSize()

Description copied from interface: ICaseListParameters

This method returns the optional number of cases that are shown per page, if set paging is enabled

Specified by:

getPagingSize in interface ICaseListParameters

Returns:

The number of cases per page, may be null.

getCaseAggregate

public IAggregateDefinition getCaseAggregate()

Specified by:

getCaseAggregate in interface ICaseListParameters