Package com.aquima.interactions.process.dao.dto

Class CaseViewCriteria

java.lang.Object

com.aquima.interactions.process.dao.dto.CaseViewCriteria

public class CaseViewCriteria
extends Object

Encapsulates the criteria for querying case views. Criteria include:

• what data to include in the returned views (projection)
• what filtering to do (selection)
• how to sort the results (ordering)
• whether to apply pagination, which page to retrieve and how big a page should be (pagination)

Since:

9.9

Author:

Petru Galanton

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PAGING_SIZE	The default paging size if not otherwise specified.

Constructor Summary

Constructors

Constructor	Description
CaseViewCriteria()	Creates a CaseViewCriteria which does not take into account ignore mode settings.
CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings)	Creates a CaseViewCriteria with the specified ignore mode settings, no limit, total counting enabled, paging size of 5 and record start 0.
CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings, int pagingSize, int recordStart, boolean countTotal)
CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings, int pagingSize, int recordStart, boolean countTotal, int limit)	Creates a CaseViewCriteria.

Method Summary

Modifier and Type	Method	Description
CaseViewCriteria	addAttribute(TypedAttributeReference attribute)
CaseViewCriteria	addCaseProperty(CaseProperty caseProperty)
CaseViewCriteria	addFilter(IViewFilter filter)
CaseViewCriteria	addOrder(ProcessViewOrder order)
TypedAttributeReference[]	getAttributes()
CaseProperty[]	getCaseProperties()
IViewFilter[]	getFilters()
IgnoreMode	getIgnoreMode()	Returns the effective Application ID ignore mode, based on what Application ID has been set and the ignore mode settings.
ILanguage	getLanguage()	Returns the current language.
int	getLimit()
ProcessViewOrder[]	getOrder()
int	getPagingSize()
int	getRecordStart()
boolean	hasCaseProperty(CaseProperty taskProperty)
boolean	hasLanguage()
boolean	hasLimit()
boolean	hasUserFilters()
boolean	isTotalRequested()
CaseViewCriteria	setApplicationId(ApplicationID appId)
CaseViewCriteria	setLanguage(ILanguage language)
CaseViewCriteria	setLimit(int limit)
CaseViewCriteria	setPagingSize(int pagingSize)
CaseViewCriteria	setRecordStart(int start)
CaseViewCriteria	setTotalRequested(boolean countTotal)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PAGING_SIZE

public static final int DEFAULT_PAGING_SIZE

The default paging size if not otherwise specified.

See Also:

• Constant Field Values

Constructor Details

CaseViewCriteria

public CaseViewCriteria()

Creates a CaseViewCriteria which does not take into account ignore mode settings.

CaseViewCriteria

public CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings)

Creates a CaseViewCriteria with the specified ignore mode settings, no limit, total counting enabled, paging size of 5 and record start 0.

Parameters:

ignoreModeSettings - the ignore mode settings which control the application ID filter

CaseViewCriteria

public CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings,
 int pagingSize,
 int recordStart,
 boolean countTotal)

CaseViewCriteria

public CaseViewCriteria(IIgnoreModeSettings ignoreModeSettings,
 int pagingSize,
 int recordStart,
 boolean countTotal,
 int limit)

Creates a CaseViewCriteria.

Parameters:

ignoreModeSettings - the ignore mode settings which control the Application ID filter

pagingSize - the paging size

recordStart - the record to start at

countTotal - whether counting total results is requested

limit - the applicable limit (values <= 0 indicate no limit)

Method Details

getOrder

public ProcessViewOrder[] getOrder()

getPagingSize

public int getPagingSize()

setPagingSize

public CaseViewCriteria setPagingSize(int pagingSize)

getRecordStart

public int getRecordStart()

setRecordStart

public CaseViewCriteria setRecordStart(int start)

hasLimit

public boolean hasLimit()

getLimit

public int getLimit()

setLimit

public CaseViewCriteria setLimit(int limit)

addFilter

public CaseViewCriteria addFilter(IViewFilter filter)

getFilters

public IViewFilter[] getFilters()

setApplicationId

public CaseViewCriteria setApplicationId(ApplicationID appId)

getIgnoreMode

public IgnoreMode getIgnoreMode()

Returns the effective Application ID ignore mode, based on what Application ID has been set and the ignore mode settings.

Returns:

the current effective ignore mode

addCaseProperty

public CaseViewCriteria addCaseProperty(CaseProperty caseProperty)

getCaseProperties

public CaseProperty[] getCaseProperties()

hasCaseProperty

public boolean hasCaseProperty(CaseProperty taskProperty)

addAttribute

public CaseViewCriteria addAttribute(TypedAttributeReference attribute)

getAttributes

public TypedAttributeReference[] getAttributes()

addOrder

public CaseViewCriteria addOrder(ProcessViewOrder order)

hasUserFilters

public boolean hasUserFilters()

isTotalRequested

public boolean isTotalRequested()

setTotalRequested

public CaseViewCriteria setTotalRequested(boolean countTotal)

getLanguage

public ILanguage getLanguage()

Returns the current language.

Returns:

The language, may be null.

setLanguage

public CaseViewCriteria setLanguage(ILanguage language)

hasLanguage

public boolean hasLanguage()