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

   1 /*
   2  * Copyright (C) 2016, 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.jcustomercore.model.customer;
  18
  19 import java.io.Serializable;
  20 import javax.ejb.Remote;
  21 import org.mxchange.jcustomercore.exceptions.CustomerAlreadyRegisteredException;
  22 import org.mxchange.jcustomercore.exceptions.CustomerNotFoundException;
  23
  24 /**
  25  * An interface for customer beans
  26  * <p>
  27  * @author Roland Häder<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          * Tries to find a customer with given id number (not customer number). If
  43          * not found, an exception is thrown.
  44          * <p>
  45          * @param customerId Customer id
  46          * <p>
  47          * @return Valid customer instance
  48          * <p>
  49          * @throws CustomerNotFoundException If a customer cannot be found
  50          */
  51         Customer findCustomerById (final Long customerId) throws CustomerNotFoundException;
  52
  53         /**
  54          * Checks if the the given customer instance is already registered
  55          * <p>
  56          * @param customer Customer instance
  57          * <p>
  58          * @return Whether the customer is already registered
  59          */
  60         boolean isRegistered (final Customer customer);
  61
  62         /**
  63          * Registers the customer and creates a customer number after succesful
  64          * persisting.
  65          * <p>
  66          * @param customer Initial customer instance
  67          * <p>
  68          * @return Prepared Customer instance
  69          * <p>
  70          * @throws CustomerAlreadyRegisteredException If the customer is already
  71          * registered.
  72          */
  73         Customer registerCustomer (final Customer customer) throws CustomerAlreadyRegisteredException;
  74
  75 }