src/org/mxchange/jcontactsbusiness/model/headquarter/AdminHeadquarterSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2017 - 2024 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.jcontactsbusiness.model.headquarter;
  18
  19 import java.io.Serializable;
  20 import javax.ejb.Remote;
  21 import org.mxchange.jcontactsbusiness.exceptions.headquarter.HeadquarterAlreadyAddedException;
  22
  23 /**
  24  * An administrative remote interface for company headquarter data
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org>
  27  */
  28 @Remote
  29 public interface AdminHeadquarterSessionBeanRemote extends Serializable {
  30
  31         /**
  32          * Adds given headquarter entity to persistence. If the headquarter'
  33          * address was already added, a proper exception is thrown. The parameter is
  34          * validated before being accepted like that branchId is not set.
  35          * <p>
  36          * @param headquarter Headquarter instance
  37          * <p>
  38          * @return Updated headquarter instance
  39          * <p>
  40          * @throws HeadquarterAlreadyAddedException If the headquarter' address
  41          * was already added
  42          */
  43         Headquarter addHeadquarter (final Headquarter headquarter) throws HeadquarterAlreadyAddedException;
  44
  45 }