src/org/mxchange/jfinancials/model/receipt_item/FinancialReceiptItemSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2017 - 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 General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jfinancials.model.receipt_item;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jfinancials.exceptions.receipt_item.ReceiptItemAlreadyAddedException;
  23 import org.mxchange.jfinancials.model.receipt.BillableReceipt;
  24 import org.mxchange.jusercore.model.user.User;
  25
  26 /**
  27  * A remote interface for financial receipt items
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 @Remote
  32 public interface FinancialReceiptItemSessionBeanRemote extends Serializable {
  33
  34         /**
  35          * Returns a list of all receipt items
  36          * <p>
  37          * @return A list of all receipt items
  38          */
  39         List<BillableReceiptItem> allReceiptItems ();
  40
  41         /**
  42          * Returns a list of all items by given receipt instance
  43          * <p>
  44          * @param receipt Receipt instance
  45          * <p>
  46          * @return A list of all assigned receipt items
  47          */
  48         List<BillableReceiptItem> allReceiptItems (final BillableReceipt receipt);
  49
  50         /**
  51          * Returns a list of all user's receipt items
  52          * <p>
  53          * @param user User instance to get all receipts for
  54          * <p>
  55          * @return A list of all user's receipt items
  56          */
  57         List<BillableReceiptItem> allUsersReceiptItems (final User user);
  58
  59         /**
  60          * Adds given receipt item and returns the updated version. If the receipt
  61          * item has already been found, a proper exception is being thrown.
  62          * <p>
  63          * @param receiptItem Receipt item being added
  64          * <p>
  65          * @return Updated receipt
  66          * <p>
  67          * @throws ReceiptItemAlreadyAddedException If the receipt item has already
  68          * been added
  69          */
  70         BillableReceiptItem addReceiptItem (final BillableReceiptItem receiptItem) throws ReceiptItemAlreadyAddedException;
  71
  72 }