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

Interface IWorkListParameters

All Known Implementing Classes:
XmlWorkListParameters
public interface IWorkListParameters
Interface describing the parameters for the work list container.
Since:
7.1
Author:
Jon van Leuven

  • 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.

    • getLockedStyles

      PresentationStyle[] getLockedStyles()
      This method returns the optional presentation styles that should be used for locked records.
      Returns:
      The presentation styles

    • getGroupByCase

      boolean getGroupByCase()
      This method returns the boolean flag if the worklist should group all tasks per case.
      Returns:
      Boolean indicating if the worklist should group all tasks by case.

    • shouldIgnoreCurrentUser

      boolean shouldIgnoreCurrentUser()
      This method returns the boolean flag if the current user can be ignored so all tasks are returned
      Returns:
      Boolean indicating if the current user can be ignored

    • shouldShowStartedTasks

      boolean shouldShowStartedTasks()
      This method returns the boolean flag if started tasks should be displayed as well
      Returns:
      Boolean indicating if started tasks should be displayed

    • getPagingSize

      IntegerValue getPagingSize()
      This method returns the optional number of tasks that are shown per page, if set paging is enabled
      Returns:
      The number of tasks per page, may be null.

    • getTaskIdTargetAttribute

      AttributeReference getTaskIdTargetAttribute()
      This method returns the optional target attribute for the taskId.
      Returns:
      The attribute reference for the taskId, 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

      IWorkListColumn[] getColumns()
      This method returns the configured columns.
      Returns:
      The configured columns, never null.

    • getCaseAggregate

      IAggregateDefinition getCaseAggregate()
      This method returns the case aggregate for the work list container.
      Returns:
      The configured case aggregate, never null.