src/org/mxchange/jcontactsbusiness/model/branchoffice/AdminBranchOfficeSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2017 - 2022 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.branchoffice;
  18
  19 import java.io.Serializable;
  20 import javax.ejb.Remote;
  21 import org.mxchange.jcontactsbusiness.exceptions.branchoffice.BranchOfficeAlreadyAddedException;
  22 import org.mxchange.jcontactsbusiness.exceptions.branchoffice.BranchOfficeNotFoundException;
  23
  24 /**
  25  * A remote interface for branch offices
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface AdminBranchOfficeSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Adds given branch office entity to persistence. If the branch office's
  34          * address was already added, a proper exception is thrown. The parameter is
  35          * validated before being accepted like that branchId is not set.
  36          * <p>
  37          * @param branchOffice Branch office instance
  38          * <p>
  39          * @return Updated branch office instance
  40          * <p>
  41          * @throws BranchOfficeAlreadyAddedException If the branch office's address
  42          * was already added
  43          */
  44         BranchOffice addBranchOffice (final BranchOffice branchOffice) throws BranchOfficeAlreadyAddedException;
  45
  46         /**
  47          * Updates given branch office data in database.
  48          * <p>
  49          * @param branchOffice Branch office instance being updated
  50          * <p>
  51          * @return Updated branch office instance
  52          * <p>
  53          * @throws BranchOfficeNotFoundException If given branch office instance is
  54          * not found.
  55          */
  56         BranchOffice updateBranchOffice (final BranchOffice branchOffice) throws BranchOfficeNotFoundException;
  57
  58 }