Package com.aquima.interactions.process.search

Class CaseCriteria

java.lang.Object
com.aquima.interactions.process.search.CaseCriteria
public class CaseCriteria extends Object
This class may be used to create a selection criteria for cases.
Since:
9.1
Author:
A.Pragt

  • Constructor Details

    • CaseCriteria

      public CaseCriteria()
      Creates a new instance which does not take into account process engine settings related to application id ignore mode.

    • CaseCriteria

      public CaseCriteria(IIgnoreModeSettings settings)
      Creates a new instance which takes into account process engine settings related to application id ignore mode.
      Parameters:
      settings - the process engine settings

  • Method Details

    • hasCaseIdFilter

      public boolean hasCaseIdFilter()
      Indicates whether this criteria has a case ID filter.
      Returns:
      true if a case ID filter exists in this criteria, false otherwise.

    • hasStatusFilter

      public boolean hasStatusFilter()
      This method returns an indicator whether this criteria has a status filter.
      Returns:
      Indicator of having a status filter.

    • hasNameFilter

      public boolean hasNameFilter()
      This method returns an indicator whether this criteria has a name filter.
      Returns:
      Indicator of having a status filter.

    • hasAppIdFilter

      public boolean hasAppIdFilter()
      This method returns an indicator whether this criteria has an app id filter.
      Returns:
      Indicator of having an app id filter.

    • setCaseIdFilter

      public PropertyFilter setCaseIdFilter()
      This method sets a case ID filter in this criteria.
      Returns:
      the created filter for case ID.

    • setStatusFilter

      public PropertyFilter setStatusFilter()
      This method sets a status filter to the criteria.
      Returns:
      The filter.

    • setNameFilter

      public PropertyFilter setNameFilter()
      This method sets a name filter to the criteria.
      Returns:
      The filter.

    • hasCreationDateFilter

      public boolean hasCreationDateFilter()
      This method returns an indicator whether this criteria has a creationDate filter.
      Returns:
      Indicator of having a creationDate filter.

    • setCreationDateFilter

      public PropertyFilter setCreationDateFilter()
      This method sets a creationDate filter to the criteria.
      Returns:
      The filter.

    • setAppIdFilter

      public PropertyFilter setAppIdFilter()
      This method sets an app id filter to the criteria. This method should be used when custom queries are needed. For normal use, see setAppIdFilter(ApplicationID).
      Returns:
      The filter.

    • setAppIdFilter

      public void setAppIdFilter(ApplicationID appId)
      Sets a filter which 'matches' the given application id. The semantics of 'matches' depend on the process engine settings for the given application.
      • if app id ignore mode is not configured or is 'none', this method adds an EQUALS filter for the given application id
      • if app id ignore mode is 'version', this method adds a LIKE filter for the given application id, matching only on the application name
      • if app id ignore mode is 'all', this method has no effect, no filter is added on application id
      Parameters:
      appId - the application id to filter on

    • getCaseIdFilter

      public PropertyFilter getCaseIdFilter()
      This method returns the caseId filter.
      Returns:
      the caseId filter

    • getStatusFilter

      public PropertyFilter getStatusFilter()
      This method returns the status filter.
      Returns:
      The type filter.

    • getNameFilter

      public PropertyFilter getNameFilter()
      This method returns the status filter.
      Returns:
      The type filter.

    • getCreationDateFilter

      public PropertyFilter getCreationDateFilter()
      This method returns the creationDate filter.
      Returns:
      The type filter.

    • getAppIdFilter

      public PropertyFilter getAppIdFilter()
      This method returns the app Id filter.
      Returns:
      The type filter.

    • hasAttributeFilter

      public boolean hasAttributeFilter(AttributeReference attribute)
      This method returns an indicator whether this criteria has a filter for the specified attribute.
      Parameters:
      attribute - the attribute
      Returns:
      Indicator of having a filter for the specified attribute.

    • getFilteredAttributes

      public AttributeReference[] getFilteredAttributes()
      This method returns all attributes that have a filter.
      Returns:
      All filtered attributes.

    • getAttributeFilter

      public PropertyFilter getAttributeFilter(AttributeReference attribute)
      This method returns the filter for a specified attribute.
      Parameters:
      attribute - The attribute.
      Returns:
      The filter of the attribute.

    • addAttributeFilter

      public PropertyFilter addAttributeFilter(AttributeReference attribute, boolean loweredIndex)
      This method adds an attribute filter to the criteria.
      Parameters:
      attribute - attribute to add filter for
      loweredIndex - set to true if filter attribute has a lower index in the database (only possible on StringValue attributes since Hibernate 6)
      Returns:
      The filter.

    • getLimit

      public Integer getLimit()
      This method returns the limit that is currently set for this criteria
      Returns:
      The limit, null or an Integer representing a positive non-zero integer

    • setLimit

      public void setLimit(Integer limit)
      This method sets the limit on the number of results returned from the database
      Parameters:
      limit - The limit, null or an Integer representing a positive non-zero integer