Package com.aquima.interactions.composer.model.list.state

Class ListConfiguration

java.lang.Object

com.aquima.interactions.composer.model.list.state.ListConfiguration

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CaseListConfiguration, InstanceListConfiguration, WorkListConfiguration

public abstract class ListConfiguration
extends Object
implements Serializable

Class to remember the state of the list.

Since:

9.2

Author:

Nicky van Noorloos

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListConfiguration(SortingState sortingState, PagingState pagingState)	Constructs a new ListState.

Method Summary

Modifier and Type	Method	Description
String	getJsonSearch()	Returns the JSON search value.
PagingState	getPagingState()
SortingState	getSortingState()
boolean	isLimited()	Checks whether the total number of pages should be limited.
void	setJsonSearch(String value)	Sets the JSON search value.
void	setLimited(boolean isLimited)	Sets whether total number of pages should be limited.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

• Constant Field Values

Constructor Details

ListConfiguration

protected ListConfiguration(SortingState sortingState,
 PagingState pagingState)

Constructs a new ListState.

Parameters:

sortingState - the list sorting state

pagingState - the list paging state

Method Details

getPagingState

public PagingState getPagingState()

getSortingState

public SortingState getSortingState()

isLimited

public boolean isLimited()

Checks whether the total number of pages should be limited. This is not the same as saying a limit is defined. A limit may be defined but not applied, if the user chooses to show all results.

Returns:

true if the list should be limited, false otherwise

setLimited

public void setLimited(boolean isLimited)

Sets whether total number of pages should be limited. This is not the same as saying a limit is defined. A limit may be defined, but the user may choose to show all results

Parameters:

isLimited - whether total number of pages should be limited

setJsonSearch

public void setJsonSearch(String value)

Sets the JSON search value.

The JSON value is set on the global search field after every request, in order to maintain the search state of the list. See CaseViewFilterBuilder, TaskViewFilterBuilder and related classes for more details about the JSON search string.

Parameters:

value - a JSON string

getJsonSearch

public String getJsonSearch()

Returns the JSON search value.

Returns:

the JSON search value