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

Class XmlWorkListParameters

java.lang.Object

com.aquima.interactions.framework.container.worklist.config.impl.XmlWorkListParameters

All Implemented Interfaces:

IWorkListParameters

public final class XmlWorkListParameters
extends Object
implements IWorkListParameters

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

Since:

7.1

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCKED_PRESENTATION_STYLES
static final String	PRESENTATIONSTYLE_NAME

Method Summary

Modifier and Type	Method	Description
IAggregateDefinition	getCaseAggregate()	This method returns the case aggregate for the work list container.
AttributeReference	getCaseIdTargetAttribute()	This method returns the optional target attribute for the caseId.
IWorkListColumn[]	getColumns()	This method returns the configured columns.
boolean	getGroupByCase()	This method returns the boolean flag if the worklist should group all tasks per case.
PresentationStyle[]	getLockedStyles()	This method returns the optional presentation styles that should be used for locked records.
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 tasks that are shown per page, if set paging is enabled
AttributeReference	getTaskIdTargetAttribute()	This method returns the optional target attribute for the taskId.
static IWorkListParameters	parseParameters(IContainerContext context, IMetaModel caseModel)
boolean	shouldIgnoreCurrentUser()	This method returns the boolean flag if the current user can be ignored so all tasks are returned
boolean	shouldShowStartedTasks()	This method returns the boolean flag if started tasks should be displayed as well

Methods inherited from class java.lang.Object

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

Field Details

LOCKED_PRESENTATION_STYLES

public static final String LOCKED_PRESENTATION_STYLES

See Also:

• Constant Field Values

PRESENTATIONSTYLE_NAME

public static final String PRESENTATIONSTYLE_NAME

See Also:

• Constant Field Values

Method Details

parseParameters

public static IWorkListParameters parseParameters(IContainerContext context,
 IMetaModel caseModel)

getColumns

public IWorkListColumn[] getColumns()

Description copied from interface: IWorkListParameters

This method returns the configured columns.

Specified by:

getColumns in interface IWorkListParameters

Returns:

The configured columns, never null.

getCaseAggregate

public IAggregateDefinition getCaseAggregate()

Description copied from interface: IWorkListParameters

This method returns the case aggregate for the work list container.

Specified by:

getCaseAggregate in interface IWorkListParameters

Returns:

The configured case aggregate, never null.

getLockedStyles

public PresentationStyle[] getLockedStyles()

Description copied from interface: IWorkListParameters

This method returns the optional presentation styles that should be used for locked records.

Specified by:

getLockedStyles in interface IWorkListParameters

Returns:

The presentation styles

getPagingSize

public IntegerValue getPagingSize()

Description copied from interface: IWorkListParameters

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

Specified by:

getPagingSize in interface IWorkListParameters

Returns:

The number of tasks per page, may be null.

getCaseIdTargetAttribute

public AttributeReference getCaseIdTargetAttribute()

Description copied from interface: IWorkListParameters

This method returns the optional target attribute for the caseId.

Specified by:

getCaseIdTargetAttribute in interface IWorkListParameters

Returns:

The attribute reference for the caseId, may be null.

getTaskIdTargetAttribute

public AttributeReference getTaskIdTargetAttribute()

Description copied from interface: IWorkListParameters

This method returns the optional target attribute for the taskId.

Specified by:

getTaskIdTargetAttribute in interface IWorkListParameters

Returns:

The attribute reference for the taskId, may be null.

getNoResultTextItem

public String getNoResultTextItem()

Description copied from interface: IWorkListParameters

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

Specified by:

getNoResultTextItem in interface IWorkListParameters

Returns:

The text item name, may be null.

getGroupByCase

public boolean getGroupByCase()

Description copied from interface: IWorkListParameters

This method returns the boolean flag if the worklist should group all tasks per case.

Specified by:

getGroupByCase in interface IWorkListParameters

Returns:

Boolean indicating if the worklist should group all tasks by case.

shouldIgnoreCurrentUser

public boolean shouldIgnoreCurrentUser()

Description copied from interface: IWorkListParameters

This method returns the boolean flag if the current user can be ignored so all tasks are returned

Specified by:

shouldIgnoreCurrentUser in interface IWorkListParameters

Returns:

Boolean indicating if the current user can be ignored

shouldShowStartedTasks

public boolean shouldShowStartedTasks()

Description copied from interface: IWorkListParameters

This method returns the boolean flag if started tasks should be displayed as well

Specified by:

shouldShowStartedTasks in interface IWorkListParameters

Returns:

Boolean indicating if started tasks should be displayed