content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.core.transaction.changetracking;
  
  import java.util.function.Function;
  
  import org.springframework.beans.factory.DisposableBean;
  import org.jspecify.annotations.Nullable;
  
  import org.apache.causeway.commons.collections.Can;
  import org.apache.causeway.core.metamodel.object.ManagedObject;
  import org.apache.causeway.core.metamodel.services.objectlifecycle.PropertyChangeRecord;
  
  /**
   * Responsible for collecting the details of all changes to domain objects
   * within a transaction.
   *
   * @since 1.x but renamed/refactored for v2 {@index}
   */
  public interface EntityChangeTracker extends DisposableBean {
  
      /**
       * Publishing support: for object stores to enlist an object that has just been created,
       * capturing a dummy value <tt>'[NEW]'</tt> for the pre-modification value.
       *
       * <p>
       * The post-modification values are captured when the transaction commits.
       * </p>
       */
      void enlistCreated(ManagedObject entity);
  
      /**
       * Publishing support: for object stores to enlist an object that is about to be updated,
       * capturing the pre-modification values of the properties of the {@link ManagedObject}.
       *
       * <p>
       * The post-modification values are captured when the transaction commits.
       *
       * <p>
       * Overload as an optimization for ORMs (specifically, JPA) where already have access to the changed records by
       * accessing the ORM-specific data structures (<code>EntityManager</code>'s unit-of-work).
       *
       * </p>
       *
       * @param entity
       * @param propertyChangeRecordSupplier - optional parameter (as a performance optimization)
       *      to provide the pre-computed {@link PropertyChangeRecord}s from the ORM.  JPA does this, JDO does not.
       */
      void enlistUpdating(ManagedObject entity, @Nullable Function<ManagedObject, Can<PropertyChangeRecord>> propertyChangeRecordSupplier);
  
      /**
       * Publishing support: for object stores to enlist an object that is about to be deleted,
       * capturing the pre-deletion value of the properties of the {@link ManagedObject}.
       *
       * <p>
       * The post-modification values are captured  when the transaction commits.  In the case of deleted objects, a
       * dummy value <tt>'[DELETED]'</tt> is used as the post-modification value.
       * </p>
       */
      void enlistDeleting(ManagedObject entity) ;
  
      /**
       * Not strictly part of the concern of entity tracking, but allows the default implementation to also implement
       * the {@link org.apache.causeway.applib.services.metrics.MetricsService}.
       */
      void incrementLoaded(ManagedObject entity);
  
  }
  
  