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

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

public interface DocumentosDAO {

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

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

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

  /**
   * Obtiene la suma de los valores de los documentos en una Caja
   *
   * @param caja Caja a la que pertencene los Documentos
   * @return La suma de los valores de los documentos, si la Caja es Caja.EMPYY retorana 0
   */
  int getTotalDocumentos(Caja caja);

  /**
   * Guarda un nuevo documentos, le otorga un id una vez guardado.
   * @param documentos Documentos a guardar
   */
  void insert(Documentos documentos);

  /**
   * Actualiza un documentos
   * @param documentos Documento a actualizar
   */
  void update(Documentos documentos);

  /**
   * Elimina un Documentos.
   * @param documentos Documentos a eliminar
   */
  void delete(Documentos documentos);
}
