Package io.camunda.client.api.search.filter

Interface ElementInstanceFilter

All Superinterfaces:
TypedFilterableRequest.SearchRequestFilter
All Known Implementing Classes:
ElementInstanceFilterImpl
public interface ElementInstanceFilter extends TypedFilterableRequest.SearchRequestFilter

  • Method Details

    • elementInstanceKey

      ElementInstanceFilter elementInstanceKey(long value)
      Filters element instances by the specified key.
      Parameters:
      value - the key of element instance
      Returns:
      the updated filter

    • processDefinitionKey

      ElementInstanceFilter processDefinitionKey(long value)
      Filters element instances by process definition key.
      Parameters:
      value - the process definition key of element instance
      Returns:
      the updated filter

    • processDefinitionId

      ElementInstanceFilter processDefinitionId(String value)
      Filters element instances by bpmn process id.
      Parameters:
      value - the bpmn process id of element instance
      Returns:
      the updated filter

    • processInstanceKey

      ElementInstanceFilter processInstanceKey(long value)
      Filters element instances by process instance key.
      Parameters:
      value - the process instance key of element instance
      Returns:
      the updated filter

    • elementId

      ElementInstanceFilter elementId(String value)
      Filters element instances by element id.
      Parameters:
      value - the element id of element instance
      Returns:
      the updated filter

    • elementName

      ElementInstanceFilter elementName(String value)
      Filters element instances by element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data.
      Parameters:
      value - the element name of element instance
      Returns:
      the updated filter

    • state

      ElementInstanceFilter state(ElementInstanceState value)
      Filters element instances by state.
      Parameters:
      value - the state of element instance
      Returns:
      the updated filter

    • state

      ElementInstanceFilter state(Consumer<ElementInstanceStateProperty> fn)
      Filter by state using ElementInstanceStateProperty consumer

    • type

      ElementInstanceFilter type(ElementInstanceType value)
      Filters element instances by type.
      Parameters:
      value - the type of element instance
      Returns:
      the updated filter

    • hasIncident

      ElementInstanceFilter hasIncident(boolean value)
      Filters element instances by incident (has an incident)
      Parameters:
      value - has the element instance an incident
      Returns:
      the updated filter

    • incidentKey

      ElementInstanceFilter incidentKey(long value)
      Filters element instances by incident key.
      Parameters:
      value - the incident key for element instance
      Returns:
      the updated filter

    • tenantId

      ElementInstanceFilter tenantId(String value)
      Filters element instances by tenant id.
      Parameters:
      value - the tenant id for element instance
      Returns:
      the updated filter

    • startDate

      ElementInstanceFilter startDate(OffsetDateTime value)
      Filters element instances by start date.
      Parameters:
      value - the start date of the element instance
      Returns:
      the updated filter

    • startDate

      ElementInstanceFilter startDate(Consumer<DateTimeProperty> startDate)
      Filters element instances by the specified DateTimeProperty start date.
      Parameters:
      startDate - the start date of the element instance
      Returns:
      the updated filter

    • endDate

      ElementInstanceFilter endDate(OffsetDateTime value)
      Filters element instances by end date.
      Parameters:
      value - the end date of the element instance
      Returns:
      the updated filter

    • endDate

      ElementInstanceFilter endDate(Consumer<DateTimeProperty> endDate)
      Filters element instances by the specified DateTimeProperty end date.
      Parameters:
      endDate - the end date of the element instance
      Returns:
      the updated filter

    • elementInstanceScopeKey

      ElementInstanceFilter elementInstanceScopeKey(long value)
      Filters element instances by the specified scope key.
      Parameters:
      value - the scope key of the element instance
      Returns:
      the updated filter