git.mxchange.org Git - jfinancials-war.git/blob

   1 /*
   2  * Copyright (C) 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 Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (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 Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jfinancials.beans.business.branchoffice;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcontactsbusiness.exceptions.branchoffice.BranchOfficeNotFoundException;
  22 import org.mxchange.jcontactsbusiness.model.branchoffice.BranchOffice;
  23
  24 /**
  25  * An interface for general branch office controller
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface FinancialsBranchOfficeWebRequestController extends Serializable {
  30
  31         /**
  32          * Returns a list of all branch offices
  33          * <p>
  34          * @return A list of all branch offices
  35          */
  36         List<BranchOffice> allBranchOffices ();
  37
  38         /**
  39          * Tries to find a branch office with given id number
  40          * <p>
  41          * @param branchOfficeId Branch office id
  42          * <p>
  43          * @return A branch office instance
  44          * <p>
  45          * @throws BranchOfficeNotFoundException If the branch office was not found
  46          */
  47         BranchOffice findBranchOfficeById (final Long branchOfficeId) throws BranchOfficeNotFoundException;
  48
  49 }