package org.apache.torque.manager;

/*
 * 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.
 */

import java.util.List;

import org.apache.torque.Column;
import org.apache.torque.om.Persistent;

/**
 * Listener for cache events
 *
 * @param <T> The database object class for which this instance is a listener.
 * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
 * @version $Id: CacheListener.java 1728149 2016-02-02 15:27:42Z tv $
 */
public interface CacheListener<T extends Persistent>
{
    /**
     * Notify listener that an object has been added to the database
     *
     * @param om the object
     */
    void addedObject(T om);

    /**
     * Notify listener that an object has been modified
     *
     * @param om the object
     */
    void refreshedObject(T om);

    /**
     * Notify listener that an object has been removed from the database
     *
     * @param om the object
     */
    void removedObject(T om);

    /**
     * Get the list of fields we are listening for
     *
     * @return a list of fields, not null
     */
    List<Column> getInterestedFields();
}
