src/org/mxchange/jcustomercore/model/customer/AdminCustomerSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   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.jcustomercore.model.customer;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException;
  23 import org.mxchange.jcustomercore.exceptions.CustomerAlreadyRegisteredException;
  24
  25 /**
  26  * Administrative interface for customer beans
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 @Remote
  31 public interface AdminCustomerSessionBeanRemote extends Serializable {
  32
  33         /**
  34          * Returns a list of all customers. This method should be used from
  35          * administrative beans.
  36          * <p>
  37          * @return A list of all customers
  38          */
  39         List<Customer> allCustomers ();
  40
  41         /**
  42          * Adds the given customer instance to database and returns an updated
  43          * instance.
  44          * <p>
  45          * @param customer Customer instance
  46          * <p>
  47          * @return Updated customer
  48          * <p>
  49          * @throws
  50          * org.mxchange.jcustomercore.exceptions.CustomerAlreadyRegisteredException
  51          * If the customer is already registered.
  52          * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException If
  53          * the given contact data is already added.
  54          */
  55         Customer addCustomer (final Customer customer) throws CustomerAlreadyRegisteredException, ContactAlreadyAddedException;
  56
  57         /**
  58          * Creates a new (free) customer number.
  59          * <p>
  60          * @return Free customer number (no free number should not happen)
  61          */
  62         String createCustomerNumber ();
  63
  64 }