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

   1 /*
   2  * Copyright (C) 2017 Roland Häder
   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.jfinancials.model.receipt.item.BillableReceiptItem;
  25 import org.mxchange.jusercore.model.user.User;
  26
  27 /**
  28  * A remote interface for financial receipt items
  29  * <p>
  30  * @author Roland Häder<roland@mxchange.org>
  31  */
  32 @Remote
  33 public interface FinancialReceiptItemSessionBeanRemote extends Serializable {
  34
  35         /**
  36          * Returns a list of all receipt items
  37          * <p>
  38          * @return A list of all receipt items
  39          */
  40         List<BillableReceiptItem> allReceiptItems ();
  41
  42         /**
  43          * Returns a list of all items by given receipt instance
  44          * <p>
  45          * @param receipt Receipt instance
  46          * <p>
  47          * @return A list of all assigned receipt items
  48          */
  49         List<BillableReceiptItem> allReceiptItems (final BillableReceipt receipt);
  50
  51         /**
  52          * Returns a list of all user's receipt items
  53          * <p>
  54          * @param user User instance to get all receipts for
  55          * <p>
  56          * @return A list of all user's receipt items
  57          */
  58         List<BillableReceiptItem> allUsersReceiptItems (final User user);
  59
  60         /**
  61          * Adds given receipt item and returns the updated version. If the receipt
  62          * item has already been found, a proper exception is being thrown.
  63          * <p>
  64          * @param receiptItem Receipt item being added
  65          * <p>
  66          * @return Updated receipt
  67          * <p>
  68          * @throws ReceiptItemAlreadyAddedException If the receipt item has already
  69          * been added
  70          */
  71         BillableReceiptItem addReceiptItem (final BillableReceiptItem receiptItem) throws ReceiptItemAlreadyAddedException;
  72
  73 }