Package io.jmix.core.querycondition

Interface Condition

All Superinterfaces:

Serializable

All Known Implementing Classes:

JpqlCondition, LogicalCondition, PropertyCondition, SkippableCondition

public interface Condition
extends Serializable

The tree of Conditions represents an optional part of a query that is added if the corresponding parameters are present.

Method Summary

Modifier and Type	Method	Description
Condition	actualize(Set<String> actualParameters, boolean defaultSkipNullOrEmpty)	Checks whether the argument contains all parameters specified in the condition.
Condition	copy()	Returns a deep copy of this condition.
Set<String>	getExcludedParameters(Set<String> actualParameters)	Returns names of parameters that are not present in the given actualParameters but have null or empty value.
Collection<String>	getParameters()	Returns parameters specified in the condition.

Method Details

getParameters

Collection<String> getParameters()

Returns parameters specified in the condition.

actualize

@Nullable
Condition actualize(Set<String> actualParameters,
 boolean defaultSkipNullOrEmpty)

Checks whether the argument contains all parameters specified in the condition.

Parameters:

defaultSkipNullOrEmpty - default value for SkippableCondition.skipNullOrEmpty, should be obtained using CoreProperties.isSkipNullOrEmptyConditionsByDefault()

Returns:

the condition if SkippableCondition.skipNullOrEmpty is false or if actualParameters contains all parameters specified in the condition and these parameters are not null or empty. Otherwise returns null.

copy

Condition copy()

Returns a deep copy of this condition.

getExcludedParameters

Set<String> getExcludedParameters(Set<String> actualParameters)

Returns names of parameters that are not present in the given actualParameters but have null or empty value.

For SkippableCondition, empty parameters are not included in the result if SkippableCondition.skipNullOrEmpty() is false.