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

import danielcortes.xyz.models.caja.Caja;
import danielcortes.xyz.models.tipo_ingreso.TipoIngreso;
import java.time.YearMonth;
import java.util.List;
import java.util.Optional;

public interface IngresoDAO {

  /**
   * Obtiene todos los Ingreso
   * @return Lista con los Ingreso
   */
  List<Ingreso> getAll();

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

  /**
   * Obtiene los Ingreso segun su TipoIngreso
   * @param tipoIngreso TipoIngreso al que pertenece el Ingreso
   * @return Lista con los Ingreso
   */
  List<Ingreso> getByTipoIngreso(TipoIngreso tipoIngreso);

  /**
   * Obtiene un Ingreso segun su Id
   * @param id Id del Ingreso
   * @return Optional que puede contener un Ingreso o puede estar Vacio
   */
  Optional<Ingreso> getById(int id);

  /**
   * Obtiene la suma de los valores de los Ingreso en una Caja
   * @param caja Caja a la que pertenecen los Ingreso a sumar
   * @return La suma de los valores de los Ingreso
   */
  int getTotalIngreso(Caja caja);

  /**
   * Obtiene el total de la suma de los valores de los Ingresos en un mes
   * @param mes Mes al que pertenecen los Ingreso
   * @return La suma del valor de los Ingreso  en el mes
   */
  int getTotalIngresoMes(YearMonth mes);

  /**
   * Obtiene el total de Ingresos de TipoIngreso 'Boleta Exenta'.
   * @param mes Mes en el que estan los Ingreso
   * @return La suma de los valores de los Ingreso
   */
  int getTotalExentasMes(YearMonth mes);

  /**
   * Obtiene el total de la suma de los Ingreso de una Caja segun su TipoIngreso
   * @param caja Caja a la que pertenecen los Ingreso
   * @param tipoIngreso TipoIngreso a los que pertenecen los Ingreso
   * @return El total de la suma de los Ingreso
   */
  int getTotalIngresoEnCajaPorTipo(Caja caja, TipoIngreso tipoIngreso);

  /**
   * Obtiene el Primer numero de los NroInicial de los Ingreso de una Caja pertenecientes a un TipoIngreso
   * @param caja Caja a la que pertenecen los Ingreso
   * @param tipoIngreso TipoIngreso al que pertenecen los Ingreso
   * @return Un Optional que puede contener el NroInicial o puede estar vacio
   */
  Optional<String> getPrimerNroInicialDeCajaDeTipo(Caja caja, TipoIngreso tipoIngreso);

  /**
   * Obtiene el Ultimo numero de los NroFinal de los Ingreso de una Caja pertenecientes a un TipoIngreso
   * @param caja Caja a la que pertenecen los Ingreso
   * @param tipoIngreso TipoIngreso al que pertenecen los Ingreso
   * @return Un Optional que puede contener el NroFinal o puede estar vacio
   */
  Optional<String> getUltimoNroFinalDeCajaDeTipo(Caja caja, TipoIngreso tipoIngreso);

  /**
   * Obtiene el Primer numero de los NroZInicial de los Ingreso de una Caja pertenecientes al TipoIngreso Boleta Fiscal
   * @param caja Caja a la que pertenecen los Ingreso
   * @return Un Optional que puede contener el NroZInicial o puede estar vacio
   */
  Optional<String> getPrimerNroZInicialDeCaja(Caja caja);

  /**
   * Obtiene el Ultimo numero de los NroZFinal de los Ingresos de una Caja pertenecientes al TipoIngreso Boleta Fiscal
   * @param caja Caja a la que pertenecen los Ingreso
   * @return Un Optional que puede contener el NroZFinal o puede estar vacio
   */
  Optional<String> getUltimoNroZFinalDeCaja(Caja caja);

  /**
   * Guarda un Ingreso y le otorga un id
   * @param ingreso Ingreso a guardar
   */
  void insert(Ingreso ingreso);

  /**
   * Actualiza un Ingreso
   * @param ingreso Ingreso a actualizar
   */
  void update(Ingreso ingreso);

  /**
   * Elimina un Ingreso
   * @param ingreso Ingreso a eliminar
   */
  void delete(Ingreso ingreso);

}
