Package org.hibernate.engine.spi

Interface CascadingAction<T>

All Known Implementing Classes:
CascadingActions.BaseCascadingAction
public interface CascadingAction<T>
A session action that may be cascaded from parent entity to its children
Author:
Gavin King, Steve Ebersole

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cascade(EventSource session, Object child, String entityName, T anything, boolean isCascadeDeleteEnabled)
    Cascade the action to the child object.
    boolean
    deleteOrphans()
    Does this action potentially extrapolate to orphan deletes?
    Iterator<?>
    getCascadableChildrenIterator(EventSource session, CollectionType collectionType, Object collection)
    Given a collection, get an iterator of the children upon which the current cascading action should be visited.
    default void
    noCascade(EventSource session, Object parent, EntityPersister persister, Type propertyType, int propertyIndex)
    Deprecated, for removal: This API element is subject to removal in a future version.
    No longer used
    boolean
    performOnLazyProperty()
    Should this action be performed (or noCascade consulted) in the case of lazy properties.
    default boolean
    requiresNoCascadeChecking()
    Deprecated, for removal: This API element is subject to removal in a future version.
    No longer used

  • Method Details

    • cascade

      void cascade(EventSource session, Object child, String entityName, T anything, boolean isCascadeDeleteEnabled) throws HibernateException
      Cascade the action to the child object.
      Parameters:
      session - The session within which the cascade is occurring.
      child - The child to which cascading should be performed.
      entityName - The child's entity name
      anything - Anything ;) Typically some form of cascade-local cache which is specific to each CascadingAction type
      isCascadeDeleteEnabled - Are cascading deletes enabled.
      Throws:
      HibernateException

    • getCascadableChildrenIterator

      Iterator<?> getCascadableChildrenIterator(EventSource session, CollectionType collectionType, Object collection)
      Given a collection, get an iterator of the children upon which the current cascading action should be visited.
      Parameters:
      session - The session within which the cascade is occurring.
      collectionType - The mapping type of the collection.
      collection - The collection instance.
      Returns:
      The children iterator.

    • deleteOrphans

      boolean deleteOrphans()
      Does this action potentially extrapolate to orphan deletes?
      Returns:
      True if this action can lead to deletions of orphans.

    • requiresNoCascadeChecking

      @Deprecated(since="6.6", forRemoval=true) default boolean requiresNoCascadeChecking()
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      Does the specified cascading action require verification of no cascade validity?
      Returns:
      True if this action requires no-cascade verification; false otherwise.

    • noCascade

      @Deprecated(since="6.6", forRemoval=true) default void noCascade(EventSource session, Object parent, EntityPersister persister, Type propertyType, int propertyIndex)
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      Called (in the case of requiresNoCascadeChecking() returning true) to validate that no cascade on the given property is considered a valid semantic.
      Parameters:
      session - The session within which the cascade is occurring.
      parent - The property value owner
      persister - The entity persister for the owner
      propertyType - The property type
      propertyIndex - The index of the property within the owner.

    • performOnLazyProperty

      boolean performOnLazyProperty()
      Should this action be performed (or noCascade consulted) in the case of lazy properties.