Module is.codion.framework.model

Package is.codion.framework.model

Interface ForeignKeyConditionModel.Builder

Enclosing interface:

ForeignKeyConditionModel

public static interface ForeignKeyConditionModel.Builder

A builder for a ForeignKeyConditionModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ForeignKeyConditionModel.Builder.ConnectionStep	The second step in building a ForeignKeyConditionModel
static interface	ForeignKeyConditionModel.Builder.ForeignKeyStep	The first step in building a ForeignKeyConditionModel

Method Summary

Modifier and Type	Method	Description
ForeignKeyConditionModel	build()
ForeignKeyConditionModel.Builder	caption(@Nullable String caption)
ForeignKeyConditionModel.Builder	comboBoxModel(Supplier<EntityComboBoxModel> comboBoxModel)	Supplies the combo box models, called once per operand, on first access, a separate instance per operand.
ForeignKeyConditionModel.Builder	operator(Operator operator)	Sets the initial operator, the one AttributeConditionModel.clear() reverts to.
ForeignKeyConditionModel.Builder	operators(List<Operator> operators)	Sets the available operators, a subset of Operator.EQUAL, Operator.NOT_EQUAL, Operator.IN and Operator.NOT_IN, which is the default.
ForeignKeyConditionModel.Builder	searchModel(Supplier<EntitySearchModel> searchModel)	Supplies the search models, called once per operand, on first access, a separate instance per operand.

Method Details

comboBoxModel

ForeignKeyConditionModel.Builder comboBoxModel(Supplier<EntityComboBoxModel> comboBoxModel)

Supplies the combo box models, called once per operand, on first access, a separate instance per operand. Defaults to a combo box model of the referenced entities, including null.

Parameters:

comboBoxModel - supplies the combo box models

Returns:

this builder

See Also:

• ForeignKeyConditionModel.Models.Operand.comboBoxModel()

searchModel

ForeignKeyConditionModel.Builder searchModel(Supplier<EntitySearchModel> searchModel)

Supplies the search models, called once per operand, on first access, a separate instance per operand. Defaults to a search model of the referenced entities.

Parameters:

searchModel - supplies the search models

Returns:

this builder

See Also:

• ForeignKeyConditionModel.Models.Operand.searchModel()

operators

ForeignKeyConditionModel.Builder operators(List<Operator> operators)

Sets the available operators, a subset of Operator.EQUAL, Operator.NOT_EQUAL, Operator.IN and Operator.NOT_IN, which is the default.

Parameters:

operators - the available operators

Returns:

this builder

Throws:

IllegalArgumentException - in case of an empty list or an operator not supported by a foreign key condition

operator

ForeignKeyConditionModel.Builder operator(Operator operator)

Sets the initial operator, the one AttributeConditionModel.clear() reverts to. Defaults to the first of the available operators(List).

Parameters:

operator - the initial operator, must be one of the available operators

Returns:

this builder

caption

ForeignKeyConditionModel.Builder caption(@Nullable String caption)

Parameters:

caption - the caption to associate with the condition model, the foreign key caption for example

Returns:

this builder

See Also:

• ConditionModel.caption()

build

ForeignKeyConditionModel build()

Returns:

a new ForeignKeyConditionModel instance

Throws:

IllegalArgumentException - in case the initial operator is not one of the available operators