is.codion.framework.domain.property

Interface ForeignKeyProperty.Builder

All Superinterfaces:

Property.Builder<Entity,ForeignKeyProperty.Builder>

Enclosing interface:

ForeignKeyProperty

public static interface ForeignKeyProperty.Builder
extends Property.Builder<Entity,ForeignKeyProperty.Builder>

Provides setters for ForeignKeyProperty properties

Method Summary

Modifier and Type	Method and Description
ForeignKeyProperty.Builder	fetchDepth(int fetchDepth)
ForeignKeyProperty.Builder	readOnly(Attribute<?> referenceAttribute) Marks the given foreign key reference attribute as read-only, as in, not updated when the foreign key value is set.
ForeignKeyProperty.Builder	selectAttributes(Attribute<?>... attributes) Specifies the attributes from the referenced entity to select.
ForeignKeyProperty.Builder	softReference(boolean softReference) Specifies that this foreign key is not based on a physical (table) foreign key and should not prevent deletion

Methods inherited from interface is.codion.framework.domain.property.Property.Builder

attribute, beanProperty, build, captionResourceKey, comparator, dateTimePattern, decimalRoundingMode, defaultValue, defaultValueSupplier, description, format, hidden, localeDateTimePattern, maximumFractionDigits, maximumLength, maximumValue, minimumValue, mnemonic, nullable, numberFormatGrouping, preferredColumnWidth, valueRange

Method Detail

fetchDepth

ForeignKeyProperty.Builder fetchDepth(int fetchDepth)

Parameters:

fetchDepth - the default query fetch depth for this foreign key

Returns:

this instance

softReference

ForeignKeyProperty.Builder softReference(boolean softReference)

Specifies that this foreign key is not based on a physical (table) foreign key and should not prevent deletion

Parameters:

softReference - true if this is a soft foreign key, which does not prevent deletion

Returns:

this instance

readOnly

ForeignKeyProperty.Builder readOnly(Attribute<?> referenceAttribute)

Marks the given foreign key reference attribute as read-only, as in, not updated when the foreign key value is set.

Parameters:

referenceAttribute - the reference attribute

Returns:

this instance

selectAttributes

ForeignKeyProperty.Builder selectAttributes(Attribute<?>... attributes)

Specifies the attributes from the referenced entity to select. Note that the primary key attributes are always selected and do not have to be added via this method.

Parameters:

attributes - the attributes to select

Returns:

this instance