2 * Copyright (C) 2016 - 2024 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 * A POJI for product entities
29 * @author Roland Häder<roland@mxchange.org>
31 public interface Product extends Comparable<Product>, Serializable {
34 * Getter for bar-code number
36 * @return Bar-code number
38 String getProductBarCodeNumber ();
41 * Setter for bar-code number
43 * @param productBarCodeNumber Bar-code number
45 void setProductBarCodeNumber (final String productBarCodeNumber);
48 * Getter for created timestamp
50 * @return Created timestamp
52 Date getProductEntryCreated ();
55 * Setter for created timestamp
57 * @param productEntryCreated Created timestamp
59 void setProductEntryCreated (final Date productEntryCreated);
62 * Getter for updated timestamp
64 * @return Updated timestamp
66 Date getProductEntryUpdated ();
69 * Setter for updated timestamp
71 * @param productEntryUpdated Updated timestamp
73 void setProductEntryUpdated (final Date productEntryUpdated);
76 * Getter for product availability
78 * @return Product availability
80 Boolean getProductAvailability ();
83 * Setter for product availability
85 * @param productAvailability Product availability
87 void setProductAvailability (final Boolean productAvailability);
90 * Getter for product category id
92 * @return Product category id
94 Category getProductCategory ();
97 * Setter for product category
99 * @param productCategory Product category
101 void setProductCategory (final Category productCategory);
104 * Getter for id number, suitable for form fields.
106 * @return Id number of product
108 Long getProductId ();
111 * Id number of product
113 * @param productId the id number to set
115 void setProductId (final Long productId);
118 * Getter for manufacturing/producing company
120 * @return Manufacturing/producing company
122 BasicData getProductManufacturer ();
125 * Setter for manufacturing/producing company
127 * @param productManufacturer Manufacturing/producing company
129 void setProductManufacturer (final BasicData productManufacturer);
132 * Getter for product's net price
134 * @return Product's net price
136 BigDecimal getProductNetPrice ();
139 * Setter for product's net price
141 * @param productNetPrice Product's net price
143 void setProductNetPrice (final BigDecimal productNetPrice);
146 * Getter for product's tax rate
148 * @return Product's tax rate
150 BigDecimal getProductTaxRate ();
153 * Setter for product's tax rate
155 * @param productTaxRate Product's tax rate
157 void setProductTaxRate (final BigDecimal productTaxRate);
160 * Getter for product's gross price
162 * @return Product's gross price
164 BigDecimal getProductGrossPrice ();
167 * Setter for product's gross price
169 * @param productGrossPrice Product's gross price
171 void setProductGrossPrice (final BigDecimal productGrossPrice);
174 * Getter for currency code like EUR or USD
176 * @return Currency code like EUR or USD
178 String getProductCurrencyCode ();
181 * Setter for currency code like EUR or USD
183 * @param productCurrencyCode Currency code like EUR or USD
185 void setProductCurrencyCode (final String productCurrencyCode);
188 * Getter for product's FSC number
190 * @return Product's FSC number
192 String getProductFscNumber ();
195 * Setter for product's FSC number
197 * @param productFscNumber Product's FSC number
199 void setProductFscNumber (final String productFscNumber);
202 * Getter for i18n key of product
204 * @return I18n key of product
206 String getProductI18nKey ();
209 * Setter for i18n key of product
211 * @param productI18nKey I18n key
213 void setProductI18nKey (final String productI18nKey);
216 * Getter for product's unit amount
218 * @return Product's unit amount
220 BigDecimal getProductUnitAmount ();
223 * Setter for product's unit amount
225 * @param productUnitAmount Product's unit amount
227 void setProductUnitAmount (final BigDecimal productUnitAmount);
230 * Getter for product's i18n key
232 * @return Product's i18n key
234 String getProductUnitI18nKey ();
237 * Setter for product's i18n key
239 * @param productI18nKey Product's i18n key
241 void setProductUnitI18nKey (final String productI18nKey);
244 * Getter for product's number
246 * @return Product's number
248 Long getProductNumber ();
251 * Setter for product's number
253 * @param productNumber Product's number
255 void setProductNumber (final Long productNumber);
258 * Getter for product's size
260 * @return Product's size
262 String getProductSize ();
265 * Setter for product's size
267 * @param productSize Product's size
269 void setProductSize (final String productSize);
272 * Getter for product's age group
274 * @return Product's age group
276 AgeGroup getProductAgeGroup ();
279 * Setter for product's age group
281 * @param productAgeGroup Product's age group
283 void setProductAgeGroup (final AgeGroup productAgeGroup);
286 boolean equals (final Object object);