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

   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 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.addressbook.beans.business.employee.list;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcontactsbusiness.exceptions.employee.EmployeeNotFoundException;
  22 import org.mxchange.jcontactsbusiness.model.employee.Employable;
  23
  24 /**
  25  * An interface for request-scoped administrative company employee beans
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface AddressbookEmployeeListWebViewController extends Serializable {
  30
  31         /**
  32          * Returns a list of all company employees
  33          * <p>
  34          * @return List of all company employees
  35          */
  36         List<Employable> getAllEmployees ();
  37
  38         /**
  39          * Validates if given email address is already in use by an employee
  40          * <p>
  41          * @param emailAddress Email address to be validated
  42          * <p>
  43          * @return Whether the email address is already used
  44          */
  45         Boolean isEmailAddressRegistered (final String emailAddress);
  46
  47         /**
  48          * Finds a company employee by given employee id
  49          * <p>
  50          * @param employeeId Employable id to find company employee instance for
  51          * <p>
  52          * @return Company employee instance
  53          * <p>
  54          * @throws EmployeeNotFoundException If the company employee was not found
  55          */
  56         Employable findEmployeeById (final Long employeeId) throws EmployeeNotFoundException;
  57
  58 }