src/java/org/mxchange/jfinancials/beans/generic_product/FinancialProductWebRequestController.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   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.generic_product;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Local;
  22 import javax.faces.view.facelets.FaceletException;
  23 import org.mxchange.jproduct.exceptions.product.ProductNotFoundException;
  24 import org.mxchange.jproduct.model.product.Product;
  25
  26 /**
  27  * An interface for products
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 @Local
  32 public interface FinancialProductWebRequestController extends Serializable {
  33
  34         /**
  35          * Some "getter" for a linked list of only available products
  36          * <p>
  37          * @return Only available products
  38          * <p>
  39          * @throws javax.faces.view.facelets.FaceletException If anything went wrong
  40          */
  41         List<Product> allProducts () throws FaceletException;
  42
  43         /**
  44          * Returns a product instance (entity) for given primary key. If not found,
  45          * a proper exception is thrown.
  46          * <p>
  47          * @param productId Product id (primary key)
  48          * <p>
  49          * @return Product entity matching to primary key
  50          * <p>
  51          * @throws ProductNotFoundException If a product with given primary key
  52          * could not be found
  53          */
  54         Product findProductById (final Long productId) throws ProductNotFoundException;
  55
  56 }