src/org/mxchange/jcustomercore/model/customer/CustomerSessionBeanRemote.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.jcustomercore.exceptions.CustomerAlreadyRegisteredException;
  23
  24 /**
  25  * An interface for customer beans
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface CustomerSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Fills given customer instance with all available data
  34          * <p>
  35          * @param customer Initial Customer instance
  36          * <p>
  37          * @return Prepared Customer instance
  38          */
  39         Customer fillCustomerData (final Customer customer);
  40
  41         /**
  42          * Checks if the the given customer instance is already registered
  43          * <p>
  44          * @param customer Customer instance
  45          * <p>
  46          * @return Whether the customer is already registered
  47          */
  48         boolean isReqistered (final Customer customer);
  49
  50         /**
  51          * Registers the customer and creates a customer number after succesful
  52          * persisting.
  53          * <p>
  54          * @param customer Initial customer instance
  55          * <p>
  56          * @return Prepared Customer instance
  57          * <p>
  58          * @throws
  59          * org.mxchange.jcustomercore.exceptions.CustomerAlreadyRegisteredException
  60          * If the customer is already registered.
  61          */
  62         Customer registerCustomer (final Customer customer) throws CustomerAlreadyRegisteredException;
  63
  64         /**
  65          * Returns a list of all customers. This method should be used from
  66          * administrative beans.
  67          * <p>
  68          * @return A list of all customers
  69          */
  70         List<Customer> allCustomers ();
  71
  72 }