Interface ForeignKeyProperty

  • All Superinterfaces:
    Property, Serializable

    public interface ForeignKeyProperty
    extends Property
    A wrapper property that represents a reference to another entity, typically but not necessarily based on a foreign key. These do not map directly to a underlying table column, but wrap the actual column properties involved in the relation. e.g.: Properties.foreignKeyProperty("reference_fk", Properties.columnProperty("reference_id")), where "reference_id" is the actual name of the column involved in the reference, but "reference_fk" is simply a descriptive property ID
    • Method Detail

      • isInsertable

        boolean isInsertable()
        Returns:
        true if all reference properties comprising this foreign key property are insertable
      • isUpdatable

        boolean isUpdatable()
        Returns:
        true if all reference properties comprising this foreign key property are updatable
      • getForeignEntityId

        String getForeignEntityId()
        Returns:
        the id of the entity referenced by this foreign key
      • getColumnProperties

        List<ColumnProperty> getColumnProperties()
        Returns an unmodifiable list containing the properties that comprise this foreign key
        Returns:
        the reference properties
      • isCompositeKey

        boolean isCompositeKey()
        Returns:
        true if this foreign key is based on multiple columns
      • getFetchDepth

        int getFetchDepth()
        Returns:
        the default query fetch depth for this foreign key
      • isSoftReference

        boolean isSoftReference()
        Returns:
        true if this foreign key is not based on a physical (table) foreign key and should not prevent deletion