2 * Copyright (C) 2016 - 2018 Free Software Foundation
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.
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.
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/>.
17 package org.mxchange.jproduct.model.product;
19 import java.io.Serializable;
20 import java.math.BigDecimal;
21 import java.util.Date;
22 import org.mxchange.jcontactsbusiness.model.basicdata.BasicData;
23 import org.mxchange.jproduct.model.category.Category;
24 import org.mxchange.jproduct.model.product.agegroup.AgeGroup;
27 * An interface for in database storable products
29 * @author Roland Häder<roland@mxchange.org>
31 public interface Product extends Comparable<Product>, Serializable {
34 * Getter for created timestamp
36 * @return Created timestamp
38 Date getProductCreated ();
41 * Setter for created timestamp
43 * @param productCreated Created timestamp
45 void setProductCreated (final Date productCreated);
48 * Getter for product availability
50 * @return Product availability
52 Boolean getProductAvailability ();
55 * Setter for product availability
57 * @param productAvailability Product availability
59 void setProductAvailability (final Boolean productAvailability);
62 * Getter for product category id
64 * @return Product category id
66 Category getProductCategory ();
69 * Setter for product category
71 * @param productCategory Product category
73 void setProductCategory (final Category productCategory);
76 * Getter for id number, suitable for form fields.
78 * @return Id number of product
83 * Id number of product
85 * @param productId the id number to set
87 void setProductId (final Long productId);
90 * Getter for manufacturing/producing company
92 * @return Manufacturing/producing company
94 BasicData getProductManufacturer ();
97 * Setter for manufacturing/producing company
99 * @param productManufacturer Manufacturing/producing company
101 void setProductManufacturer (final BasicData productManufacturer);
104 * Getter for product's net price
106 * @return Product's net price
108 BigDecimal getProductNetPrice ();
111 * Setter for product's net price
113 * @param productNetPrice Product's net price
115 void setProductNetPrice (final BigDecimal productNetPrice);
118 * Getter for product's tax rate
120 * @return Product's tax rate
122 BigDecimal getProductTaxRate ();
125 * Setter for product's tax rate
127 * @param productTaxRate Product's tax rate
129 void setProductTaxRate (final BigDecimal productTaxRate);
132 * Getter for product's gross price
134 * @return Product's gross price
136 BigDecimal getProductGrossPrice ();
139 * Setter for product's gross price
141 * @param productGrossPrice Product's gross price
143 void setProductGrossPrice (final BigDecimal productGrossPrice);
146 * Getter for currency code like EUR or USD
148 * @return Currency code like EUR or USD
150 String getProductCurrencyCode ();
153 * Setter for currency code like EUR or USD
155 * @param productCurrencyCode Currency code like EUR or USD
157 void setProductCurrencyCode (final String productCurrencyCode);
160 * Getter for i18n key of product
162 * @return I18n key of product
164 String getProductI18nKey ();
167 * Setter for i18n key of product
169 * @param productI18nKey I18n key
171 void setProductI18nKey (final String productI18nKey);
174 * Getter for product's unit amount
176 * @return Product's unit amount
178 BigDecimal getProductUnitAmount ();
181 * Setter for product's unit amount
183 * @param productUnitAmount Product's unit amount
185 void setProductUnitAmount (final BigDecimal productUnitAmount);
188 * Getter for product's i18n key
190 * @return Product's i18n key
192 String getProductUnitI18nKey ();
195 * Setter for product's i18n key
197 * @param productI18nKey Product's i18n key
199 void setProductUnitI18nKey (final String productI18nKey);
202 * Getter for product's number
204 * @return Product's number
206 Long getProductNumber ();
209 * Setter for product's number
211 * @param productNumber Product's number
213 void setProductNumber (final Long productNumber);
216 * Getter for product's size
218 * @return Product's size
220 String getProductSize ();
223 * Setter for product's size
225 * @param productSize Product's size
227 void setProductSize (final String productSize);
230 * Getter for product's age group
232 * @return Product's age group
234 AgeGroup getProductAgeGroup ();
237 * Setter for product's age group
239 * @param productAgeGroup Product's age group
241 void setProductAgeGroup (final AgeGroup productAgeGroup);
244 boolean equals (final Object object);