/*
 * MIT License
 *
 * Copyright (c) 2018-2019 Daniel Cortes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package danielcortes.xyz.models.efectivo;

import danielcortes.xyz.models.caja.Caja;
import java.util.List;
import java.util.Optional;

public interface EfectivoDAO {

  /**
   * Obtiene todos los Efectivo
   *
   * @return Una lista con los Efectivo
   */
  List<Efectivo> getAll();

  /**
   * Obtiene un Efectivo por su id
   *
   * @param id Id del Efectivo
   * @return Un Optional que puede contener un Efectivo o puede estar vacio
   */
  Optional<Efectivo> getById(int id);

  /**
   * Obtiene un Efectivo por su Caja
   *
   * @param caja Caja a la que pertence el Efectivo
   * @return Un Optional que puede contener un Efectivo o puede estar vacio
   */
  Optional<Efectivo> getByCaja(Caja caja);

  /**
   * Obtiene la suma de los valores de los Efectivo pertencientes a una Caja
   *
   * @param caja Caja a la que pertenecen los Efectivo a sumar
   * @return La suma de los valores de Efectivo
   */
  int getTotalEfectivo(Caja caja);

  /**
   * Guarda un Efectivo, le agrega un id a la instancia
   *
   * @param efectivo Efectivo a guardar
   */
  void insert(Efectivo efectivo);

  /**
   * Actualiza un Efectivo
   *
   * @param efectivo Efectivo a guardar
   */
  void update(Efectivo efectivo);

  /**
   * Elimina un Efectivo
   *
   * @param efectivo Efectivo a eliminar
   */
  void delete(Efectivo efectivo);
}
