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

   1 /*
   2  * Copyright (C) 2017 - 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 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 javax.ejb.Remote;
  21 import org.mxchange.jfinancials.exceptions.receipt_item.ReceiptItemAlreadyAddedException;
  22 import org.mxchange.jfinancials.exceptions.receipt_item.ReceiptItemNotFoundException;
  23
  24 /**
  25  * A remote interface for administrative EJBs for receipt items
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface FinancialAdminReceiptItemSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Updates given receipt item instance in database. If the receipt item is
  34          * not found, an exception will be thrown.
  35          * <p>
  36          * @param receiptItem Receipt item instance to update
  37          * <p>
  38          * @return Updated receipt item instance
  39          * <p>
  40          * @throws ReceiptItemNotFoundException If the given receipt item instance
  41          * was not found.
  42          */
  43         BillableReceiptItem updateReceiptItem (final BillableReceiptItem receiptItem) throws ReceiptItemNotFoundException;
  44
  45         /**
  46          * Adds given receipt item and returns the updated version. If the receipt
  47          * item has already been found, a proper exception is being thrown.
  48          * <p>
  49          * @param receiptItem Receipt item being added
  50          * <p>
  51          * @return Updated receipt item
  52          * <p>
  53          * @throws ReceiptItemAlreadyAddedException If the receipt item has already
  54          * been added
  55          */
  56         BillableReceiptItem addReceiptItem (final BillableReceiptItem receiptItem) throws ReceiptItemAlreadyAddedException;
  57
  58 }