/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.storage.core;

import com.redhat.thermostat.storage.core.AggregateQuery.AggregateFunction;
import com.redhat.thermostat.storage.model.Pojo;

/**
 * This subclass of {@link Storage} should be implemented by classes that
 * interact directly with a form of storage (e.g. a database).
 * 
 * This interface contains methods which provide capabilities we do not want to
 * expose directly to clients. Clients should instead prepare statements using
 * {@link Storage#prepareStatement(StatementDescriptor)}. The methods in this
 * interface then provide the mechanisms to execute the prepared statement, and
 * should only be used by the prepared statement implementations.
 */
public interface BackingStorage extends Storage {
    
    <T extends Pojo> Query<T> createQuery(Category<T> category);
    
    // FIXME: Thermostat 2.0 return AggregateQuery2 (or merged version of AggregateQuery) instead
    <T extends Pojo> Query<T> createAggregateQuery(AggregateFunction function, Category<T> category);
    
    <T extends Pojo> Add<T> createAdd(Category<T> category);
    
    <T extends Pojo> Replace<T> createReplace(Category<T> category);
    
    <T extends Pojo> Update<T> createUpdate(Category<T> category);
    
    <T extends Pojo> Remove<T> createRemove(Category<T> category);

}