src/org/mxchange/jfinancials/financial/receipt/FinancialReceiptSessionBeanRemote.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.financial.receipt;
  18
  19 import java.io.Serializable;
  20 import java.util.Collection;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jfinancials.exceptions.ReceiptAlreadyAddedException;
  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 stuff
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 @Remote
  32 public interface FinancialReceiptSessionBeanRemote extends Serializable {
  33
  34         /**
  35          * Returns a collection of all user's receipts
  36          * <p>
  37          * @param user User instance to get all receipts for
  38          * <p>
  39          * @return A collection of all user's receipts
  40          */
  41         Collection<? extends BillableReceipt> allUsersReceipts (final User user);
  42
  43         /**
  44          * Adds given receipt and returns the updated version. If the receipt has
  45          * already been found, a proper exception is being thrown.
  46          * <p>
  47          * @param receipt Receipt being added
  48          * <p>
  49          * @return Updated receipt
  50          * <p>
  51          * @throws ReceiptAlreadyAddedException If the receipt has already been
  52          * added
  53          */
  54         BillableReceipt addReceipt (final BillableReceipt receipt) throws ReceiptAlreadyAddedException;
  55
  56 }