camunda-bpm-platform icon indicating copy to clipboard operation
camunda-bpm-platform copied to clipboard

Published 20 hours ago • verified publisher icon camunda

Misleading Javadoc of HistoricProcessInstanceQuery#finishedAfter()

Open ThorbenLindhauer opened this issue 6 years ago • 1 comments

This issue was imported from JIRA:

Field Value
JIRA Link CAM-9110
Reporter @romansmirnov
Has restricted visibility comments false

The Javadoc of HistoricProcessInstanceQuery#finishedAfter() <1> is misleading, in a way that it is saying that only process instances that were finished after the a given date (i.e. END*TIME_ > #\{finishedAfter\}). But the actual implementation includes the given date (i.e. END_TIME* >= #\{finishedAfter\}).

AT:

  • the javadoc should document the actual behavior (i.e. >=)
  • the documentation of the REST API is adjusted accordingly
  • the same should be applied for
    • #finishedBefore()
    • #startedBefore()
    • #startedAfter()
    • HistoricActivityInstanceQuery#...
    • and all other historic queries

<1>: https://github.com/camunda/camunda-bpm-platform/blob/b75c9d267435ed9d2daae640a74d41c181721b9f/engine/src/main/java/org/camunda/bpm/engine/history/HistoricProcessInstanceQuery.java#L204-L205

Links:

  • is related to https://jira.camunda.com/browse/SUPPORT-4434

ThorbenLindhauer avatar May 29 '18 10:05 ThorbenLindhauer