Interface ICaseListParameters
- All Known Implementing Classes:
XmlCaseListParameters
public interface ICaseListParameters
Interface describing the parameters for the case list container.
- Since:
- 9.2
- Author:
- B. van de Ven
-
Method Summary
Modifier and TypeMethodDescriptionThis method returns the optional target attribute for the caseId.This method returns the configured columns.This method returns the boolean flag if the caselist should group all case attribute.This method returns the optional text to use when no results are found in the database.This method returns the optional number of cases that are shown per page, if set paging is enabled
-
Method Details
-
getNoResultTextItem
String getNoResultTextItem()This method returns the optional text to use when no results are found in the database.- Returns:
- The text item name, may be null.
-
getGroupByAttribute
AttributeReference getGroupByAttribute()This method returns the boolean flag if the caselist should group all case attribute.- Returns:
- Boolean indicating if the caselist should group all tasks by case attribute.
-
getPagingSize
IntegerValue getPagingSize()This method returns the optional number of cases that are shown per page, if set paging is enabled- Returns:
- The number of cases per page, may be null.
-
getCaseIdTargetAttribute
AttributeReference getCaseIdTargetAttribute()This method returns the optional target attribute for the caseId.- Returns:
- The attribute reference for the caseId, may be null.
-
getColumns
ICaseListColumn[] getColumns()This method returns the configured columns.- Returns:
- The configured columns, never null.
-
getCaseAggregate
IAggregateDefinition getCaseAggregate()
-