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

import danielcortes.xyz.models.caja.Caja;
import danielcortes.xyz.models.tipo_egreso.TipoEgreso;
import java.time.YearMonth;
import java.util.List;
import java.util.Optional;

public interface EgresoDAO {

  /**
   * Obtiene todos los Egreso
   * @return Lista de Egreso
   */
  List<Egreso> getAll();

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

  /**
   * Obtiene todos los Egreso pertenecientes a una Caja
   * @param caja Caja a la que pertencen los Egreso
   * @return Lista con los Egreso
   */
  List<Egreso> getByCaja(Caja caja);

  /**
   * Obtiene los Egreso dado su nro
   * @param nro nro del Egreso
   * @return Lista con los Egreso
   */
  List<Egreso> getByNro(String nro);

  /**
   * Obtiene los Egreso dado su TipoEgreso
   * @param tipoEgreso TipoEgreso al que pertence los Egreso
   * @return Lista con los Egreso
   */
  List<Egreso> getByTipoEgreso(TipoEgreso tipoEgreso);

  /**
   * Obtiene los Egreso dado su TipoEgreso y su Caja
   * @param tipoEgreso TipoEgreso al que pertence los Egreso
   * @param caja Caja al que pertence los Egreso
   * @return Lista de Egreso
   */
  List<Egreso> getByTipoEgresoEnCaja(TipoEgreso tipoEgreso, Caja caja);

  /**
   * Guarda un Egreso
   * @param egreso Egreso a guardar
   */
  void insert(Egreso egreso);

  /**
   * Actualiza un Egreso
   * @param egreso Egreso a actualizar
   */
  void update(Egreso egreso);

  /**
   * Elimina un Egreso
   * @param egreso Egreso a eliminar
   */
  void delete(Egreso egreso);

  /**
   * Obtiene la suma de los valores de Egreso en una Caja
   * @param caja Caja a la que pertencene los Egreso
   * @return La suma de los Egreso
   */
  int getTotalEgreso(Caja caja);

  /**
   * Obtiene la suma de los valores de Egreso en un mes de un TipoEgreso
   * @param mes Mes al que pertencen los Egreso
   * @param tipo TipoEgreso al que pertence los Egreso
   * @return La suma de los Egreso
   */
  int getTotalEgresoMesPorTipo(YearMonth mes, TipoEgreso tipo);

}
