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

   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.department;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcontactsbusiness.exceptions.department.DepartmentNotFoundException;
  22 import org.mxchange.jcontactsbusiness.model.department.Department;
  23
  24 /**
  25  * An interface for general department controller
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface FinancialsDepartmentWebRequestController extends Serializable {
  30
  31         /**
  32          * Returns a list of all departments
  33          * <p>
  34          * @return A list of all departments
  35          */
  36         List<Department> allDepartments ();
  37
  38         /**
  39          * Retrieves a single company department entity for given id number or
  40          * throws a proper exception if not found.
  41          * <p>
  42          * @param departmentId Company department id to lookup
  43          * <p>
  44          * @return Company department instance
  45          * <p>
  46          * @throws DepartmentNotFoundException If the id number could not be
  47          * looked up and solved into an entity
  48          */
  49         Department findDepartmentById (final Long departmentId) throws DepartmentNotFoundException;
  50
  51 }