Package org.flowable.cmmn.engine.impl.util

Class CompletionEvaluationResult

java.lang.Object

org.flowable.cmmn.engine.impl.util.CompletionEvaluationResult

public class CompletionEvaluationResult
extends Object

A class holding the result from evaluating a stage or case plan model for completion. Evaluation can happen on two modes: with autocompletion in mind or without. The difference being whether there is still optional work available or not.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	isCompletable
protected final PlanItemInstanceEntity	planItemInstance
protected final boolean	shouldBeCompleted

Constructor Summary

Constructors

Constructor	Description
CompletionEvaluationResult(boolean isCompletable, boolean shouldBeCompleted, PlanItemInstanceEntity planItemInstance)

Method Summary

Modifier and Type	Method	Description
PlanItemInstanceEntity	getPlanItemInstance()	Returns the first plan item preventing the stage or case from being completed.
boolean	isCompletable()	Returns true, if the plan item (most likely a stage or a case plan model) is completable, meaning, there is no more active or required work to be done, but it might still have available or enabled plan items.
boolean	shouldBeCompleted()	Returns true, if the plan item (most likely a stage or case plan model) should be completed according the state of all of its enclosed plan items, their required rules, availability state and the plan items autocomplete mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

isCompletable

protected final boolean isCompletable

shouldBeCompleted

protected final boolean shouldBeCompleted

planItemInstance

protected final PlanItemInstanceEntity planItemInstance

Constructor Details

CompletionEvaluationResult

public CompletionEvaluationResult(boolean isCompletable,
 boolean shouldBeCompleted,
 PlanItemInstanceEntity planItemInstance)

Method Details

isCompletable

public boolean isCompletable()

Returns true, if the plan item (most likely a stage or a case plan model) is completable, meaning, there is no more active or required work to be done, but it might still have available or enabled plan items.

Returns:

true if the plan item is completable

shouldBeCompleted

public boolean shouldBeCompleted()

Returns true, if the plan item (most likely a stage or case plan model) should be completed according the state of all of its enclosed plan items, their required rules, availability state and the plan items autocomplete mode. If autocomplete is activated, this flag will represent the same as the completable one, if not, it might be different.

Returns:

whether the plan item should be completed

getPlanItemInstance

public PlanItemInstanceEntity getPlanItemInstance()

Returns the first plan item preventing the stage or case from being completed. This will be null, if isCompletable() is true, otherwise it contains the plan item which first prevented it from being completed.

Returns:

the plan item first preventing the case or stage from being completable, might be null if it is actually completable