src/java/org/mxchange/jfinancials/beans/financial/model/receipt_item/list/FinancialsReceiptItemListWebViewController.java

   1 /*
   2  * Copyright (C) 2016 - 2020 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_item.list;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jfinancials.exceptions.receipt_item.ReceiptItemNotFoundException;
  22 import org.mxchange.jfinancials.model.receipt_item.BillableReceiptItem;
  23
  24 /**
  25  * An administrative interface for financial receipt item list beans
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface FinancialsReceiptItemListWebViewController extends Serializable {
  30
  31         /**
  32          * Returns the receipt item by given primary key
  33          * <p>
  34          * @param receiptItemId Receipt item's primary key
  35          * <p>
  36          * @return Receipt item instance
  37          * <p>
  38          * @throws ReceiptItemNotFoundException If the receipt item cannot be found
  39          */
  40         BillableReceiptItem findReceiptItemById (final Long receiptItemId) throws ReceiptItemNotFoundException;
  41
  42         /**
  43          * Checks if receipt item has already been added to database
  44          * <p>
  45          * @param receiptItem Prepared receipt item instance
  46          * <p>
  47          * @return Whether the receipt item has already been added
  48          */
  49         boolean isReceiptItemAdded (final BillableReceiptItem receiptItem);
  50
  51         /**
  52          * Returns all receipt items
  53          * <p>
  54          * @return All receipt items
  55          */
  56         List<BillableReceiptItem> getAllReceiptItems ();
  57
  58 }