src/java/org/mxchange/jfinancials/beans/phone/list/FinancialsPhoneListWebViewController.java

   1 /*
   2  * Copyright (C) 2016 - 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.jfinancials.beans.phone.list;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jphone.exceptions.phone.PhoneEntityNotFoundException;
  22 import org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber;
  23 import org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber;
  24
  25 /**
  26  * An interface for a request web controller (bean) for administrative phone
  27  * number purposes.
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 public interface FinancialsPhoneListWebViewController extends Serializable {
  32
  33         /**
  34          * Returns a list of all fax numbers. For performance reasons, the
  35          * controller (bean) should be view-scoped as from user to user nothing
  36          * changes. And the controller's post-construct method should load all
  37          * numbers and cache it in the controller.
  38          * <p>
  39          * @return List of all fax numbers
  40          */
  41         List<DialableFaxNumber> getAllFaxNumbers ();
  42
  43         /**
  44          * Returns a list of all land-line numbers. For performance reasons, the
  45          * controller (bean) should be view-scoped as from user to user nothing
  46          * changes. And the controller's post-construct method should load all
  47          * numbers and cache it in the controller.
  48          * <p>
  49          * @return List of all land-line numbers
  50          */
  51         List<DialableLandLineNumber> getAllLandLineNumbers ();
  52
  53         /**
  54          * Finds a fax entry by given id number
  55          * <p>
  56          * @param faxNumberId Fax entry id number
  57          * <p>
  58          * @return A valid fax instance
  59          * <p>
  60          * @throws PhoneEntityNotFoundException If the entity was not found
  61          */
  62         DialableFaxNumber findFaxNumberById (final Long faxNumberId) throws PhoneEntityNotFoundException;
  63
  64         /**
  65          * Finds a land-line entry by given id number
  66          * <p>
  67          * @param landLineNumberId Land-line entry id number
  68          * <p>
  69          * @return A valid land-line instance
  70          * <p>
  71          * @throws PhoneEntityNotFoundException If the entity was not found
  72          */
  73         DialableLandLineNumber findLandLineNumberById (final Long landLineNumberId) throws PhoneEntityNotFoundException;
  74
  75 }