src/org/mxchange/jfinancials/model/receipt/FinancialReceiptSessionBeanRemote.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;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jfinancials.exceptions.receipt.ReceiptAlreadyAddedException;
  23 import org.mxchange.jusercore.model.user.User;
  24
  25 /**
  26  * A remote interface for financial receipts
  27  * <p>
  28  * @author Roland Häder<roland@mxchange.org>
  29  */
  30 @Remote
  31 public interface FinancialReceiptSessionBeanRemote extends Serializable {
  32
  33         /**
  34          * Returns a list of all receipts
  35          * <p>
  36          * @return A list of all receipts
  37          */
  38         List<BillableReceipt> allReceipts ();
  39
  40         /**
  41          * Returns a list of all user's receipts
  42          * <p>
  43          * @param user User instance to get all receipts for
  44          * <p>
  45          * @return A list of all user's receipts
  46          */
  47         List<BillableReceipt> allUsersReceipts (final User user);
  48
  49         /**
  50          * Adds given receipt and returns the updated version. If the receipt has
  51          * already been found, a proper exception is being thrown.
  52          * <p>
  53          * @param receipt Receipt being added
  54          * <p>
  55          * @return Updated receipt
  56          * <p>
  57          * @throws ReceiptAlreadyAddedException If the receipt has already been
  58          * added
  59          */
  60         BillableReceipt addReceipt (final BillableReceipt receipt) throws ReceiptAlreadyAddedException;
  61
  62         /**
  63          * Checks if given receipt is already persisted by checking receipt number
  64          * and branch office combination.
  65          * <p>
  66          * @param receipt Receipt instance
  67          * <p>
  68          * @return Whether the receipt has already been registered
  69          */
  70         boolean isReceiptRegistered (final BillableReceipt receipt);
  71
  72 }