Module is.codion.framework.model

Package is.codion.framework.model

Interface ForeignKeyConditionModel

All Superinterfaces:

AttributeConditionModel<Entity>, ConditionModel<Entity>

public interface ForeignKeyConditionModel
extends AttributeConditionModel<Entity>

A foreign key condition model. The Operator.EQUAL and Operator.IN operand components are each based on either a EntitySearchModel or a EntityComboBoxModel.

The operands are plain values, independent of these models, a component based on a model must be linked to the operand it edits, ConditionModel.Operands.equal() or ConditionModel.Operands.in(). Entities of the referenced type updated or deleted are replaced in, or removed from, the operands, via PersistenceEvents.

See Also:

• ConditionModel.builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ForeignKeyConditionModel.Builder	A builder for a ForeignKeyConditionModel.

Nested classes/interfaces inherited from interface is.codion.common.model.condition.ConditionModel

ConditionModel.Operands<T>, ConditionModel.SetCondition<T>, ConditionModel.Wildcard

Field Summary

Fields inherited from interface is.codion.common.model.condition.ConditionModel

AUTO_ENABLE, CASE_SENSITIVE, WILDCARD, WILDCARD_CHARACTER

Method Summary

Modifier and Type	Method	Description
ForeignKey	attribute()
static ForeignKeyConditionModel.Builder	builder(ForeignKey foreignKey)
Optional<EntityComboBoxModel>	equalComboBoxModel()	Note that the selection of this combo box model is not the EQUAL operand, a component based on it must be linked to ConditionModel.Operands.equal().
Optional<EntitySearchModel>	equalSearchModel()	Note that the selection of this search model is not the EQUAL operand, a component based on it must be linked to ConditionModel.Operands.equal().
Optional<EntityComboBoxModel>	inComboBoxModel()	Note that the selection of this combo box model is not the IN operand, a component based on it must be linked to ConditionModel.Operands.in().
Optional<EntitySearchModel>	inSearchModel()	Note that the selection of this search model is not the IN operand, a component based on it must be linked to ConditionModel.Operands.in().

Methods inherited from interface is.codion.framework.model.AttributeConditionModel

accepts, autoEnable, caseSensitive, clear, condition, dateTimePattern, enabled, format, locked, operands, operator, operators, set, valueClass

Methods inherited from interface is.codion.common.model.condition.ConditionModel

caption, changed

Method Details

attribute

ForeignKey attribute()

Specified by:

attribute in interface AttributeConditionModel<Entity>

Returns:

the attribute

equalSearchModel

Optional<EntitySearchModel> equalSearchModel()

Note that the selection of this search model is not the EQUAL operand, a component based on it must be linked to ConditionModel.Operands.equal().

Returns:

the EntitySearchModel to base the EQUAL operand component on, an empty Optional if the EQUAL operand is not based on a search model

equalComboBoxModel

Optional<EntityComboBoxModel> equalComboBoxModel()

Note that the selection of this combo box model is not the EQUAL operand, a component based on it must be linked to ConditionModel.Operands.equal().

Returns:

the EntityComboBoxModel to base the EQUAL operand component on, an empty Optional if the EQUAL operand is not based on a combo box model

inSearchModel

Optional<EntitySearchModel> inSearchModel()

Note that the selection of this search model is not the IN operand, a component based on it must be linked to ConditionModel.Operands.in(). The selection being the value pending in that component, a second IN component for the same condition requires a search model of its own.

Returns:

the EntitySearchModel to base the IN operand component on, an empty Optional if the IN operand is not based on a search model

inComboBoxModel

Optional<EntityComboBoxModel> inComboBoxModel()

Note that the selection of this combo box model is not the IN operand, a component based on it must be linked to ConditionModel.Operands.in(). The selection being the value pending in that component, a second IN component for the same condition requires a combo box model of its own.

Returns:

the EntityComboBoxModel to base the IN operand component on, an empty Optional if the IN operand is not based on a combo box model

builder

static ForeignKeyConditionModel.Builder builder(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a new ForeignKeyConditionModel.Builder