src/org/mxchange/jproduct/model/category/Category.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 General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jproduct.model.category;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21
  22 /**
  23  * An interface for categories
  24  * <p>
  25  * @author Roland Häder<roland@mxchange.org>
  26  */
  27 public interface Category extends Serializable {
  28
  29         /**
  30          * Getter for created timestamp
  31          * <p>
  32          * @return Created timestamp
  33          */
  34         Date getCategoryCreated ();
  35
  36         /**
  37          * Setter for created timestamp
  38          * <p>
  39          * @param categoryCreated Created timestamp
  40          */
  41         void setCategoryCreated (final Date categoryCreated);
  42
  43         /**
  44          * Id number of category
  45          * <p>
  46          * @return the id
  47          */
  48         Long getCategoryId ();
  49
  50         /**
  51          * Id number of category
  52          * <p>
  53          * @param id the id to set
  54          */
  55         void setCategoryId (final Long id);
  56
  57         /**
  58          * Getter for if category is shown in any statistics
  59          * <p>
  60          * @return Whether this category is shown in any statistics
  61          */
  62         Boolean getCategoryShownInStatistics ();
  63
  64         /**
  65          * Setter for if category is shown in any statistics
  66          * <p>
  67          * @param categoryShownInStatistics Whether this category is shown in any
  68          *                                  statistics
  69          */
  70         void setCategoryShownInStatistics (final Boolean categoryShownInStatistics);
  71
  72         /**
  73          * Parent category
  74          * <p>
  75          * @return the parent category
  76          */
  77         Category getParentCategory ();
  78
  79         /**
  80          * Parent category
  81          * <p>
  82          * @param parentCategory the parent category to set
  83          */
  84         void setParentCategory (final Category parentCategory);
  85
  86         /**
  87          * Title of category
  88          * <p>
  89          * @return the title
  90          */
  91         String getCategoryI18nKey ();
  92
  93         /**
  94          * Title of category
  95          * <p>
  96          * @param title the title to set
  97          */
  98         void setCategoryI18nKey (final String title);
  99
 100         @Override
 101         boolean equals (final Object object);
 102
 103         @Override
 104         int hashCode ();
 105
 106 }