git.mxchange.org Git - jfinancials-war.git/blob

   1 /*
   2  * Copyright (C) 2022 Free Software Foundation
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jfinancials.beans.financial.model.receipt.list;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jfinancials.exceptions.receipt.ReceiptNotFoundException;
  22 import org.mxchange.jfinancials.model.receipt.BillableReceipt;
  23
  24 /**
  25  * An interface of receipt list backing beans
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface FinancialsReceiptListWebViewController extends Serializable {
  30
  31         /**
  32          * Returns a receipt instance (entity) for given primary key. If not found,
  33          * a proper exception is thrown.
  34          * <p>
  35          * @param receiptId Receipt id (primary key)
  36          * <p>
  37          * @return Receipt entity matching to primary key
  38          * <p>
  39          * @throws ReceiptNotFoundException If a receipt with given primary key
  40          * could not be found
  41          */
  42         BillableReceipt findReceiptById (final Long receiptId) throws ReceiptNotFoundException;
  43
  44         /**
  45          * Checks if receipt has already been added to database
  46          * <p>
  47          * @param receipt Prepared receipt instance
  48          * <p>
  49          * @return Whether the receipt has already been added
  50          */
  51         boolean isReceiptAdded (final BillableReceipt receipt);
  52
  53         /**
  54          * Returns all receipts
  55          * <p>
  56          * @return All receipts
  57          */
  58         public List<BillableReceipt> getAllReceipts ();
  59
  60 }