Package com.aquima.interactions.process.search

Class TaskCriteria

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

  • Constructor Details

    • TaskCriteria

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

    • TaskCriteria

      public TaskCriteria(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

    • hasAppIdFilter

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

    • hasRequiredFilter

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

    • hasCaseIdFilter

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

    • hasNameFilter

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

    • hasTypeFilter

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

    • hasStatusFilter

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

    • hasPriorityFilter

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

    • hasAssigneeFilter

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

    • hasNodeIdFilter

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

    • hasStartDateFilter

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

    • hasTimeoutDateFilter

      public boolean hasTimeoutDateFilter()
      This method returns an indicator whether this criteria has a time out date filter.
      Returns:
      Indicator of having a time out date filter.

    • hasDueDateFilter

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

    • hasEventNameFilter

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

    • setAppIdFilter

      public PropertyFilter setAppIdFilter()
      This method sets a appId 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

    • setRequiredFilter

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

    • setCaseIdFilter

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

    • setNameFilter

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

    • setTypeFilter

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

    • setStatusFilter

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

    • setPriorityFilter

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

    • setAssigneeFilter

      public AssigneeFilter setAssigneeFilter()
      This method sets an assignee filter to the criteria.
      Returns:
      The filter.

    • setNodeIdFilter

      public PropertyFilter setNodeIdFilter()
      This method sets a node id filter to the criteria.
      Returns:
      The filter.

    • setStartDateFilter

      public PropertyFilter setStartDateFilter()
      This method sets a start date filter to the criteria.
      Returns:
      The filter.

    • setTimeoutDateFilter

      public PropertyFilter setTimeoutDateFilter()
      This method sets a time out date filter to the criteria.
      Returns:
      The filter.

    • setDueDateFilter

      public PropertyFilter setDueDateFilter()
      This method sets a due date filter to the criteria.
      Returns:
      The filter.

    • setEventNameFilter

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

    • getAppIdFilter

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

    • getRequiredFilter

      public PropertyFilter getRequiredFilter()
      This method returns the requiored filter.
      Returns:
      The required filter.

    • getCaseIdFilter

      public PropertyFilter getCaseIdFilter()
      This method returns the case id filter.
      Returns:
      The case id filter.

    • getNameFilter

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

    • getTypeFilter

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

    • getStatusFilter

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

    • getPriorityFilter

      public PropertyFilter getPriorityFilter()
      This method returns the priority filter.
      Returns:
      The priority filter.

    • getAssigneeFilter

      public AssigneeFilter getAssigneeFilter()
      This method returns the assignee filter.
      Returns:
      The assignee filter.

    • getNodeIdFilter

      public PropertyFilter getNodeIdFilter()
      This method returns the node id filter.
      Returns:
      The node id filter.

    • getStartDateFilter

      public PropertyFilter getStartDateFilter()
      This method returns the start date filter.
      Returns:
      The start date filter.

    • getTimeoutDateFilter

      public PropertyFilter getTimeoutDateFilter()
      This method returns the time out date filter.
      Returns:
      The due date filter.

    • getDueDateFilter

      public PropertyFilter getDueDateFilter()
      This method returns the due date filter.
      Returns:
      The due date filter.

    • getEventNameFilter

      public PropertyFilter getEventNameFilter()
      This method returns the event name filter.
      Returns:
      The event name 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.

    • hasCustomFieldFilter

      public boolean hasCustomFieldFilter(String customField)
      This method returns an indicator whether this criteria has a filter for the specified custom field.
      Parameters:
      customField - the custom field
      Returns:
      Indicator of having a filter for the specified custom field.

    • getFilteredCustomFields

      public String[] getFilteredCustomFields()
      This method returns all custom fields that have a filter.
      Returns:
      All filtered custom fields.

    • getCustomFieldFilter

      public PropertyFilter getCustomFieldFilter(String customField)
      This method returns the filter for a specified custom field.
      Parameters:
      customField - The custom field.
      Returns:
      The filter of the custom field.

    • addCustomFieldFilter

      public PropertyFilter addCustomFieldFilter(String customField)
      This method adds a custom field filter to the criteria.
      Parameters:
      customField - the custom field
      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