Module is.codion.framework.domain

Package is.codion.framework.domain.entity.attribute

Interface ForeignKey.ForeignKeyDefiner

All Superinterfaces:

Attribute.AttributeDefiner<Entity>

Enclosing interface:

ForeignKey

public static interface ForeignKey.ForeignKeyDefiner
extends Attribute.AttributeDefiner<Entity>

Provides ForeignKeyDefinition.Builder instances.

Method Summary

Modifier and Type	Method	Description
ForeignKeyDefinition.Builder	foreignKey()	Instantiates a ForeignKeyDefinition.Builder instance, using the fetch depth specified by ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH
ForeignKeyDefinition.Builder	foreignKey(int fetchDepth)	Instantiates a ForeignKeyDefinition.Builder instance.
ForeignKeyDefinition.Builder	softForeignKey()	Instantiates a ForeignKeyDefinition.Builder instance, using the fetch depth specified by ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH.
ForeignKeyDefinition.Builder	softForeignKey(int fetchDepth)	Instantiates a ForeignKeyDefinition.Builder instance.

Methods inherited from interface is.codion.framework.domain.entity.attribute.Attribute.AttributeDefiner

attribute, denormalized, derived

Method Details

foreignKey

ForeignKeyDefinition.Builder foreignKey()

Instantiates a ForeignKeyDefinition.Builder instance, using the fetch depth specified by ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH

Returns:

a new ForeignKeyDefinition.Builder

See Also:

• ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH

foreignKey

ForeignKeyDefinition.Builder foreignKey(int fetchDepth)

Instantiates a ForeignKeyDefinition.Builder instance.

 Fetch depth:
 -1: the full foreign key graph of the referenced entity is fetched.
  0: the referenced entity not fetched.
  1: the referenced entity is fetched, without any foreign key references.
  2: the referenced entity is fetched, with a single level of foreign key references.
  3: the referenced entity is fetched, with two levels of foreign key references.
  4: etc...
  

Parameters:

fetchDepth - the number of levels of foreign key references to fetch for this foreign key

Returns:

a new ForeignKeyDefinition.Builder

Throws:

IllegalArgumentException - in case fetch depth is less than 0

softForeignKey

ForeignKeyDefinition.Builder softForeignKey()

Instantiates a ForeignKeyDefinition.Builder instance, using the fetch depth specified by ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH. This foreign key is marked as being soft, that is, not based on a physical (table) foreign key and should not prevent deletion

Returns:

a new ForeignKeyDefinition.Builder

See Also:

• ForeignKeyDefinition.FOREIGN_KEY_FETCH_DEPTH

softForeignKey

ForeignKeyDefinition.Builder softForeignKey(int fetchDepth)

Instantiates a ForeignKeyDefinition.Builder instance. This foreign key is marked as being soft, that is, not based on a physical (table) foreign key and should not prevent deletion

 Fetch depth:
 -1: the full foreign key graph of the referenced entity is fetched.
  0: the referenced entity not fetched.
  1: the referenced entity is fetched, without any foreign key references.
  2: the referenced entity is fetched, with a single level of foreign key references.
  3: the referenced entity is fetched, with two levels of foreign key references.
  4: etc...
  

Parameters:

fetchDepth - the number of levels of foreign key references to fetch for this foreign key

Returns:

a new ForeignKeyDefinition.Builder

Throws:

IllegalArgumentException - in case fetch depth is less than 0