src/java/org/mxchange/addressbook/beans/business/department/list/AddressbookDepartmentListWebViewController.java

   1 /*
   2  * Copyright (C) 2017 - 2024 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.department.list;
  18
  19 import java.io.Serializable;
  20 import org.mxchange.jcontactsbusiness.exceptions.department.DepartmentNotFoundException;
  21 import org.mxchange.jcontactsbusiness.model.department.Department;
  22
  23 /**
  24  * An interface for general department controller
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org>
  27  */
  28 public interface AddressbookDepartmentListWebViewController extends Serializable {
  29
  30         /**
  31          * Retrieves a single company department entity for given id number or
  32          * throws a proper exception if not found.
  33          * <p>
  34          * @param departmentId Company department id to lookup
  35          * <p>
  36          * @return Company department instance
  37          * <p>
  38          * @throws DepartmentNotFoundException If the id number could not be looked
  39          * up and solved into an entity
  40          */
  41         Department findDepartmentById (final Long departmentId) throws DepartmentNotFoundException;
  42
  43         /**
  44          * Checks whether the given department is already found in local cache.
  45          * Please note that this method fully relies on the cache, so you must
  46          * always fire proper events that add/update/delete entries in cache.
  47          * <p>
  48          * @param department Department to check it's address
  49          * <p>
  50          * @return Whether the address has been found
  51          */
  52         boolean isDepartmentAlreadyAdded (final Department department);
  53
  54 }