// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.orsup.base;

import java.io.*;

public interface CacheMaintenanceListener
{
    /**
     * Look at the pCommitParticipants and if you are interested in any create a
     * non-null Serializable return value with any data that you need to update your cache.
     * <p/>
     * If the transaction is successfully commited, then the updateCache() method will be called.
     *
     * @param pCommitParticipants !null & !empty array of POs that are one of: updated, insert, deleted, or "new & deleted".
     *
     * @return !null means you want to be notified that the Transaction Commit Succeeded!
     */
    Serializable aboutToCommit( PersistentObject[] pCommitParticipants );

    /**
     * This method is used to update your cache from information derived from "some" machine in a Cluster
     * successfully commiting a Transaction with the return value from this "class"'s aboutToCommit method.
     *
     * @param pAboutToCommitReturnValue !null return value from aboutToCommit( ... )
     */
    void updateCache( Serializable pAboutToCommitReturnValue );
}