src/java/org/mxchange/jfinancials/beans/business/branchoffice/list/FinancialsBranchOfficeListWebViewController.java

   1 /*
   2  * Copyright (C) 2017 - 2020 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 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.list;
  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 FinancialsBranchOfficeListWebViewController extends Serializable {
  30
  31         /**
  32          * Checks if given email address is already registered by an other branch
  33          * office
  34          * <p>
  35          * @param emailAddress Email address
  36          * <p>
  37          * @return Whether the email address has been already registered
  38          */
  39         Boolean isEmailAddressRegistered (final String emailAddress);
  40
  41         /**
  42          * Returns a list of all branch offices
  43          * <p>
  44          * @return A list of all branch offices
  45          */
  46         List<BranchOffice> getAllBranchOffices ();
  47
  48         /**
  49          * Tries to find a branch office with given id number
  50          * <p>
  51          * @param branchId Branch office id
  52          * <p>
  53          * @return A branch office instance
  54          * <p>
  55          * @throws BranchOfficeNotFoundException If the branch office was not found
  56          */
  57         BranchOffice findBranchOfficeById (final Long branchId) throws BranchOfficeNotFoundException;
  58
  59 }