ERP/3.0/Developers Guide/Reference/Entity Model/DataImportProduct
DataImportProduct
Before importing, Openbravo checks the Unit of Measure (default if not set), the Product Category (default if not set), the Business Partner, the Currency (defaults to accounting currency if not set), the Product Type (only Items and Services), the uniquen
To the database table (I_Product) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | I_Product_ID | Mandatory Max Length: 32 | java.lang.String | The ID identifies a unique product |
client | AD_Client_ID | ADClient | A Client is a company or a legal entity. You cannot share data between Clients. | |
organization | AD_Org_ID | Organization | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | |
active | IsActive | java.lang.Boolean | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:
(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions. | |
creationDate | Created | java.util.Date | The Created field indicates the date that this record was created. | |
createdBy | CreatedBy | ADUser | The Created By field indicates the user who created this record. | |
updated | Updated | java.util.Date | The Updated field indicates the date that this record was updated. | |
updatedBy | UpdatedBy | ADUser | The Updated By field indicates the user who updated this record. | |
product | M_Product_ID | Product | Identifies an item which is either purchased or sold in this organization. | |
searchKey# | Value | Max Length: 40 | java.lang.String | A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order).
Usually, company's internal identifiers for various records (products, customers, etc) are stored here. |
name | Name | Max Length: 60 | java.lang.String | A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
comments | DocumentNote | Max Length: 2000 | java.lang.String | The Document Note is used for recording any additional information regarding this product. |
helpComment | Help | Max Length: 2000 | java.lang.String | The Help field contains a hint, comment or help about the use of this item. |
uPCEAN | UPC | Max Length: 30 | java.lang.String | Use this field to enter the bar code for the product in any of the bar code symbologies (Codabar, Code 25, Code 39, Code 93, Code 128, UPC (A), UPC (E), EAN-13, EAN-8, ITF, ITF-14, ISBN, ISSN, JAN-13, JAN-8, POSTNET and FIM, MSI/Plessey, and Pharmacode) |
sKU | SKU | Max Length: 30 | java.lang.String | The SKU indicates a user defined stock keeping unit. It may be used for an additional bar code symbols or your own schema. |
eDICode | X12DE355 | Max Length: 2 | java.lang.String | The Unit of Measure Code indicates the EDI X12 Code Data Element 355 (Unit or Basis for Measurement) |
uOM | C_UOM_ID | UOM | The UOM defines a unique non monetary unit of measure | |
productCategoryKey | ProductCategory_Value | Max Length: 40 | java.lang.String | The value of the product category. This value is the short name for the group. If before inserting it doesn't exists in the table M_Product_Category_Id, it won't work |
productCategory | M_Product_Category_ID | ProductCategory | Identifies the category which this product belongs to. Product categories are used for pricing. | |
productType | ProductType | Max Length: 60 | java.lang.String | The type of product also determines accounting consequences. |
classification | Classification | Max Length: 1 | java.lang.String | The Classification can be used to optionally group products. |
volume | Volume | java.math.BigDecimal | The Volume indicates the volume of the product in the Volume UOM of the Client | |
weight | Weight | java.math.BigDecimal | The Weight indicates the weight of the product in the Weight UOM of the Client | |
shelfWidth | ShelfWidth | java.math.BigDecimal | The Shelf Width indicates the width dimension required on a shelf for a product | |
shelfHeight | ShelfHeight | java.math.BigDecimal | The Shelf Height indicates the height dimension required on a shelf for a product | |
shelfDepth | ShelfDepth | java.math.BigDecimal | The Shelf Depth indicates the depth dimension required on a shelf for a product | |
unitsPerPallet | UnitsPerPallet | java.lang.Long | The Units per Pallet indicates the number of units of this product which fit on a pallet. | |
discontinued | Discontinued | java.lang.Boolean | The Discontinued check box indicates a product that has been discontinued. | |
discontinuedBy | DiscontinuedBy | java.util.Date | The Discontinued By indicates the individual who discontinued this product | |
imageURL | ImageURL | Max Length: 120 | java.lang.String | URL of image; The image is not stored in the database, but retrieved at runtime. The image can be a gif, jpeg or png. |
descriptionURL | DescriptionURL | Max Length: 120 | java.lang.String | URL for the description |
businessPartnerSearchKey | BPartner_Value | Max Length: 40 | java.lang.String | An abbreviated name (or a code) to help find a business partner. Usually, a company's internal idenfitier is used here. |
businessPartner | C_BPartner_ID | BusinessPartner | A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these. | |
iSOCode | ISO_Code | Max Length: 3 | java.lang.String | For details - http://www.unece.org/trade/rec/rec09en.htm |
currency | C_Currency_ID | Currency | Indicates the currency to be used when processing this document. | |
listPrice | PriceList | java.math.BigDecimal | The List Price is the official price stated by the selected pricelist and the currency of the document. | |
purchaseOrderPrice | PricePO | java.math.BigDecimal | The PO Price indicates the price for a product per the purchase order. | |
royaltyAmount | RoyaltyAmt | java.math.BigDecimal | (Included) Amount for copyright, etc. | |
priceEffectiveFrom | PriceEffective | java.util.Date | The Price Effective indicates the date this price is for. This allows you to enter future prices for products which will become effective when appropriate. | |
vendorProductNo | VendorProductNo | Max Length: 40 | java.lang.String | The Vendor Product Number identifies the number used by the vendor for this product. |
vendorCategory | VendorCategory | Max Length: 30 | java.lang.String | The Vendor Category identifies the category used by the vendor for this product. |
manufacturer | Manufacturer | Max Length: 30 | java.lang.String | Manufacturer |
minimumOrderQty | Order_Min | java.lang.Long | The Minimum Order Quantity indicates the smallest quantity of this product which can be ordered. | |
quantityPerPackage | Order_Pack | java.lang.Long | The Order Pack Quantity indicates the number of units in each pack of this product. | |
fixedCostPerOrder | CostPerOrder | java.math.BigDecimal | The Cost Per Order indicates the fixed charge levied when an order for this product is placed. | |
purchasingLeadTime | DeliveryTime_Promised | java.lang.Long | Indicates the number of days between placing an order and the actual delivery as promised by the vendor. | |
processNow | Processing | java.lang.Boolean | When this field is set as 'Y' a process is being performed on this record. | |
processed | Processed | java.lang.Boolean | The Processed checkbox indicates that a document has been processed. | |
importErrorMessage | I_ErrorMsg | Max Length: 2000 | java.lang.String | The Import Error Message displays any error messages generated during the import process. |
importProcessComplete | I_IsImported | java.lang.Boolean | The Imported check box indicates if this import has been processed. |
Java Entity Class
/* ************************************************************************* * The contents of this file are subject to the Openbravo Public License * Version 1.1 (the "License"), being the Mozilla Public License * Version 1.1 with a permitted attribution clause; you may not use this * file except in compliance with the License. You may obtain a copy of * the License at http://www.openbravo.com/legal/license.html * Software distributed under the License is distributed on an "AS IS" * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the * License for the specific language governing rights and limitations * under the License. * The Original Code is Openbravo ERP. * The Initial Developer of the Original Code is Openbravo SLU * All portions are Copyright (C) 2008-2010 Openbravo SLU * All Rights Reserved. * Contributor(s): ______________________________________. ************************************************************************ */ package org.openbravo.model.dataimport; import org.openbravo.base.structure.ActiveEnabled; import org.openbravo.base.structure.BaseOBObject; import org.openbravo.base.structure.ClientEnabled; import org.openbravo.base.structure.OrganizationEnabled; import org.openbravo.base.structure.Traceable; import org.openbravo.model.ad.access.User; import org.openbravo.model.ad.system.Client; import org.openbravo.model.common.businesspartner.BusinessPartner; import org.openbravo.model.common.currency.Currency; import org.openbravo.model.common.enterprise.Organization; import org.openbravo.model.common.plm.ProductCategory; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.math.BigDecimal; import java.util.Date; /** * Entity class for entity DataImportProduct (stored in table I_Product). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Product extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "I_Product"; public static final String DataImportProduct = "DataImportProduct"; public static final String PROPERTY_ID = "id"; public static final String PROPERTY_CLIENT = "client"; public static final String PROPERTY_ORGANIZATION = "organization"; public static final String PROPERTY_ACTIVE = "active"; public static final String PROPERTY_CREATIONDATE = "creationDate"; public static final String PROPERTY_CREATEDBY = "createdBy"; public static final String PROPERTY_UPDATED = "updated"; public static final String PROPERTY_UPDATEDBY = "updatedBy"; public static final String PROPERTY_PRODUCT = "product"; public static final String PROPERTY_SEARCHKEY = "searchKey"; public static final String PROPERTY_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_COMMENTS = "comments"; public static final String PROPERTY_HELPCOMMENT = "helpComment"; public static final String PROPERTY_UPCEAN = "uPCEAN"; public static final String PROPERTY_SKU = "sKU"; public static final String PROPERTY_EDICODE = "eDICode"; public static final String PROPERTY_UOM = "uOM"; public static final String PROPERTY_PRODUCTCATEGORYKEY = "productCategoryKey"; public static final String PROPERTY_PRODUCTCATEGORY = "productCategory"; public static final String PROPERTY_PRODUCTTYPE = "productType"; public static final String PROPERTY_CLASSIFICATION = "classification"; public static final String PROPERTY_VOLUME = "volume"; public static final String PROPERTY_WEIGHT = "weight"; public static final String PROPERTY_SHELFWIDTH = "shelfWidth"; public static final String PROPERTY_SHELFHEIGHT = "shelfHeight"; public static final String PROPERTY_SHELFDEPTH = "shelfDepth"; public static final String PROPERTY_UNITSPERPALLET = "unitsPerPallet"; public static final String PROPERTY_DISCONTINUED = "discontinued"; public static final String PROPERTY_DISCONTINUEDBY = "discontinuedBy"; public static final String PROPERTY_IMAGEURL = "imageURL"; public static final String PROPERTY_DESCRIPTIONURL = "descriptionURL"; public static final String PROPERTY_BUSINESSPARTNERSEARCHKEY = "businessPartnerSearchKey"; public static final String PROPERTY_BUSINESSPARTNER = "businessPartner"; public static final String PROPERTY_ISOCODE = "iSOCode"; public static final String PROPERTY_CURRENCY = "currency"; public static final String PROPERTY_LISTPRICE = "listPrice"; public static final String PROPERTY_PURCHASEORDERPRICE = "purchaseOrderPrice"; public static final String PROPERTY_ROYALTYAMOUNT = "royaltyAmount"; public static final String PROPERTY_PRICEEFFECTIVEFROM = "priceEffectiveFrom"; public static final String PROPERTY_VENDORPRODUCTNO = "vendorProductNo"; public static final String PROPERTY_VENDORCATEGORY = "vendorCategory"; public static final String PROPERTY_MANUFACTURER = "manufacturer"; public static final String PROPERTY_MINIMUMORDERQTY = "minimumOrderQty"; public static final String PROPERTY_QUANTITYPERPACKAGE = "quantityPerPackage"; public static final String PROPERTY_FIXEDCOSTPERORDER = "fixedCostPerOrder"; public static final String PROPERTY_PURCHASINGLEADTIME = "purchasingLeadTime"; public static final String PROPERTY_PROCESSNOW = "processNow"; public static final String PROPERTY_PROCESSED = "processed"; public static final String PROPERTY_IMPORTERRORMESSAGE = "importErrorMessage"; public static final String PROPERTY_IMPORTPROCESSCOMPLETE = "importProcessComplete"; public Product() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_PRODUCTTYPE, "I"); setDefaultValue(PROPERTY_DISCONTINUED, false); setDefaultValue(PROPERTY_PROCESSNOW, false); setDefaultValue(PROPERTY_PROCESSED, false); setDefaultValue(PROPERTY_IMPORTPROCESSCOMPLETE, false); } @Override public String getEntityName() { return DataImportProduct; } public String getId() { return (String) get(PROPERTY_ID); } public void setId(String id) { set(PROPERTY_ID, id); } public Client getClient() { return (Client) get(PROPERTY_CLIENT); } public void setClient(Client client) { set(PROPERTY_CLIENT, client); } public Organization getOrganization() { return (Organization) get(PROPERTY_ORGANIZATION); } public void setOrganization(Organization organization) { set(PROPERTY_ORGANIZATION, organization); } public Boolean isActive() { return (Boolean) get(PROPERTY_ACTIVE); } public void setActive(Boolean active) { set(PROPERTY_ACTIVE, active); } public Date getCreationDate() { return (Date) get(PROPERTY_CREATIONDATE); } public void setCreationDate(Date creationDate) { set(PROPERTY_CREATIONDATE, creationDate); } public User getCreatedBy() { return (User) get(PROPERTY_CREATEDBY); } public void setCreatedBy(User createdBy) { set(PROPERTY_CREATEDBY, createdBy); } public Date getUpdated() { return (Date) get(PROPERTY_UPDATED); } public void setUpdated(Date updated) { set(PROPERTY_UPDATED, updated); } public User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } public org.openbravo.model.common.plm.Product getProduct() { return (org.openbravo.model.common.plm.Product) get(PROPERTY_PRODUCT); } public void setProduct(org.openbravo.model.common.plm.Product product) { set(PROPERTY_PRODUCT, product); } public String getSearchKey() { return (String) get(PROPERTY_SEARCHKEY); } public void setSearchKey(String searchKey) { set(PROPERTY_SEARCHKEY, searchKey); } public String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getComments() { return (String) get(PROPERTY_COMMENTS); } public void setComments(String comments) { set(PROPERTY_COMMENTS, comments); } public String getHelpComment() { return (String) get(PROPERTY_HELPCOMMENT); } public void setHelpComment(String helpComment) { set(PROPERTY_HELPCOMMENT, helpComment); } public String getUPCEAN() { return (String) get(PROPERTY_UPCEAN); } public void setUPCEAN(String uPCEAN) { set(PROPERTY_UPCEAN, uPCEAN); } public String getSKU() { return (String) get(PROPERTY_SKU); } public void setSKU(String sKU) { set(PROPERTY_SKU, sKU); } public String getEDICode() { return (String) get(PROPERTY_EDICODE); } public void setEDICode(String eDICode) { set(PROPERTY_EDICODE, eDICode); } public org.openbravo.model.common.uom.UOM getUOM() { return (org.openbravo.model.common.uom.UOM) get(PROPERTY_UOM); } public void setUOM(org.openbravo.model.common.uom.UOM uOM) { set(PROPERTY_UOM, uOM); } public String getProductCategoryKey() { return (String) get(PROPERTY_PRODUCTCATEGORYKEY); } public void setProductCategoryKey(String productCategoryKey) { set(PROPERTY_PRODUCTCATEGORYKEY, productCategoryKey); } public ProductCategory getProductCategory() { return (ProductCategory) get(PROPERTY_PRODUCTCATEGORY); } public void setProductCategory(ProductCategory productCategory) { set(PROPERTY_PRODUCTCATEGORY, productCategory); } public String getProductType() { return (String) get(PROPERTY_PRODUCTTYPE); } public void setProductType(String productType) { set(PROPERTY_PRODUCTTYPE, productType); } public String getClassification() { return (String) get(PROPERTY_CLASSIFICATION); } public void setClassification(String classification) { set(PROPERTY_CLASSIFICATION, classification); } public BigDecimal getVolume() { return (BigDecimal) get(PROPERTY_VOLUME); } public void setVolume(BigDecimal volume) { set(PROPERTY_VOLUME, volume); } public BigDecimal getWeight() { return (BigDecimal) get(PROPERTY_WEIGHT); } public void setWeight(BigDecimal weight) { set(PROPERTY_WEIGHT, weight); } public BigDecimal getShelfWidth() { return (BigDecimal) get(PROPERTY_SHELFWIDTH); } public void setShelfWidth(BigDecimal shelfWidth) { set(PROPERTY_SHELFWIDTH, shelfWidth); } public BigDecimal getShelfHeight() { return (BigDecimal) get(PROPERTY_SHELFHEIGHT); } public void setShelfHeight(BigDecimal shelfHeight) { set(PROPERTY_SHELFHEIGHT, shelfHeight); } public BigDecimal getShelfDepth() { return (BigDecimal) get(PROPERTY_SHELFDEPTH); } public void setShelfDepth(BigDecimal shelfDepth) { set(PROPERTY_SHELFDEPTH, shelfDepth); } public Long getUnitsPerPallet() { return (Long) get(PROPERTY_UNITSPERPALLET); } public void setUnitsPerPallet(Long unitsPerPallet) { set(PROPERTY_UNITSPERPALLET, unitsPerPallet); } public Boolean isDiscontinued() { return (Boolean) get(PROPERTY_DISCONTINUED); } public void setDiscontinued(Boolean discontinued) { set(PROPERTY_DISCONTINUED, discontinued); } public Date getDiscontinuedBy() { return (Date) get(PROPERTY_DISCONTINUEDBY); } public void setDiscontinuedBy(Date discontinuedBy) { set(PROPERTY_DISCONTINUEDBY, discontinuedBy); } public String getImageURL() { return (String) get(PROPERTY_IMAGEURL); } public void setImageURL(String imageURL) { set(PROPERTY_IMAGEURL, imageURL); } public String getDescriptionURL() { return (String) get(PROPERTY_DESCRIPTIONURL); } public void setDescriptionURL(String descriptionURL) { set(PROPERTY_DESCRIPTIONURL, descriptionURL); } public String getBusinessPartnerSearchKey() { return (String) get(PROPERTY_BUSINESSPARTNERSEARCHKEY); } public void setBusinessPartnerSearchKey(String businessPartnerSearchKey) { set(PROPERTY_BUSINESSPARTNERSEARCHKEY, businessPartnerSearchKey); } public BusinessPartner getBusinessPartner() { return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER); } public void setBusinessPartner(BusinessPartner businessPartner) { set(PROPERTY_BUSINESSPARTNER, businessPartner); } public String getISOCode() { return (String) get(PROPERTY_ISOCODE); } public void setISOCode(String iSOCode) { set(PROPERTY_ISOCODE, iSOCode); } public Currency getCurrency() { return (Currency) get(PROPERTY_CURRENCY); } public void setCurrency(Currency currency) { set(PROPERTY_CURRENCY, currency); } public BigDecimal getListPrice() { return (BigDecimal) get(PROPERTY_LISTPRICE); } public void setListPrice(BigDecimal listPrice) { set(PROPERTY_LISTPRICE, listPrice); } public BigDecimal getPurchaseOrderPrice() { return (BigDecimal) get(PROPERTY_PURCHASEORDERPRICE); } public void setPurchaseOrderPrice(BigDecimal purchaseOrderPrice) { set(PROPERTY_PURCHASEORDERPRICE, purchaseOrderPrice); } public BigDecimal getRoyaltyAmount() { return (BigDecimal) get(PROPERTY_ROYALTYAMOUNT); } public void setRoyaltyAmount(BigDecimal royaltyAmount) { set(PROPERTY_ROYALTYAMOUNT, royaltyAmount); } public Date getPriceEffectiveFrom() { return (Date) get(PROPERTY_PRICEEFFECTIVEFROM); } public void setPriceEffectiveFrom(Date priceEffectiveFrom) { set(PROPERTY_PRICEEFFECTIVEFROM, priceEffectiveFrom); } public String getVendorProductNo() { return (String) get(PROPERTY_VENDORPRODUCTNO); } public void setVendorProductNo(String vendorProductNo) { set(PROPERTY_VENDORPRODUCTNO, vendorProductNo); } public String getVendorCategory() { return (String) get(PROPERTY_VENDORCATEGORY); } public void setVendorCategory(String vendorCategory) { set(PROPERTY_VENDORCATEGORY, vendorCategory); } public String getManufacturer() { return (String) get(PROPERTY_MANUFACTURER); } public void setManufacturer(String manufacturer) { set(PROPERTY_MANUFACTURER, manufacturer); } public Long getMinimumOrderQty() { return (Long) get(PROPERTY_MINIMUMORDERQTY); } public void setMinimumOrderQty(Long minimumOrderQty) { set(PROPERTY_MINIMUMORDERQTY, minimumOrderQty); } public Long getQuantityPerPackage() { return (Long) get(PROPERTY_QUANTITYPERPACKAGE); } public void setQuantityPerPackage(Long quantityPerPackage) { set(PROPERTY_QUANTITYPERPACKAGE, quantityPerPackage); } public BigDecimal getFixedCostPerOrder() { return (BigDecimal) get(PROPERTY_FIXEDCOSTPERORDER); } public void setFixedCostPerOrder(BigDecimal fixedCostPerOrder) { set(PROPERTY_FIXEDCOSTPERORDER, fixedCostPerOrder); } public Long getPurchasingLeadTime() { return (Long) get(PROPERTY_PURCHASINGLEADTIME); } public void setPurchasingLeadTime(Long purchasingLeadTime) { set(PROPERTY_PURCHASINGLEADTIME, purchasingLeadTime); } public Boolean isProcessNow() { return (Boolean) get(PROPERTY_PROCESSNOW); } public void setProcessNow(Boolean processNow) { set(PROPERTY_PROCESSNOW, processNow); } public Boolean isProcessed() { return (Boolean) get(PROPERTY_PROCESSED); } public void setProcessed(Boolean processed) { set(PROPERTY_PROCESSED, processed); } public String getImportErrorMessage() { return (String) get(PROPERTY_IMPORTERRORMESSAGE); } public void setImportErrorMessage(String importErrorMessage) { set(PROPERTY_IMPORTERRORMESSAGE, importErrorMessage); } public Boolean isImportProcessComplete() { return (Boolean) get(PROPERTY_IMPORTPROCESSCOMPLETE); } public void setImportProcessComplete(Boolean importProcessComplete) { set(PROPERTY_IMPORTPROCESSCOMPLETE, importProcessComplete); } }