flowable / flowable/flowable-engine

Error in documentation of HistoricProcessInstanceQuery?

Aperta
#3,108 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
9.5k
Fork
2.9k
Merge medio
7h 8m
PR unite (30g)
2

Descrizione

I think the attached javadoc is wrong or at least very unclear. If I excute a HistoricProcessInstanceQuery with by variableValueEquals set I get both running and finished processes back - not only finished processes. The statement " The type only applies to already ended process instances" seems wrong to me? The same statement is stated in the javadoc for all variableValue*-methods.
```
/**
* Only select process instances which had a global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use a
* {@link ProcessInstanceQuery} instead! A variable type is determined based on the value, using types configured in {@link org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl#getVariableTypes()}. Byte-arrays and
* {@link Serializable} objects (which are not primitive type wrappers) are not supported.
*
* @param name
* of the variable, cannot be null.
*/
HistoricProcessInstanceQuery variableValueEquals(String name, Object value);
```

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia con il Javadoc di HistoricProcessInstanceQuery per variableValueEquals e gli altri metodi variableValue* menzionati nell’issue. Confronta la restrizione documentata con i risultati riportati per i processi in esecuzione e per quelli terminati, quindi rivedi la formulazione poco chiara o errata e verifica che la documentazione dei metodi interessati descriva il comportamento in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.