ERP 2.50:Developers Guide/Reference/Entity Model/PricingAdjustment
PricingAdjustment
The Price Adjustments have a valid period and are applied to the configured business partners, products, product categories and business partner groups. The offer can be based upon percentage or fixed price.
To the database table (M_Offer) 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* | M_Offer_ID | Mandatory Max Length: 32 | java.lang.String | Price Adjustment applied to a particular line (product) automatically by the system. |
client | AD_Client_ID | Mandatory | ADClient | A Client is a company or a legal entity. You cannot share data between Clients. |
organization | AD_Org_ID | Mandatory | Organization | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. |
active | IsActive | Mandatory | 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 | Mandatory | java.util.Date | The Created field indicates the date that this record was created. |
createdBy | Createdby | Mandatory | ADUser | The Created By field indicates the user who created this record. |
updated | Updated | Mandatory | java.util.Date | The Updated field indicates the date that this record was updated. |
updatedBy | Updatedby | Mandatory | ADUser | The Updated By field indicates the user who updated this record. |
name# | Name | Mandatory 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. |
priority | Priority | java.lang.Long | The Priority indicates the importance of this request. | |
discountAmount | Addamt | Mandatory | java.math.BigDecimal | Fixed discount amount |
discount | Discount | Mandatory | java.math.BigDecimal | The Discount indicates the discount applied or taken as a percentage. |
fixedPrice | Fixed | java.math.BigDecimal | Fixed price for the price adjustment | |
startingDate | DateFrom | Mandatory | java.util.Date | The Date From indicates the starting date of a range. |
endingDate | DateTo | java.util.Date | The Date To indicates the end date of a range (inclusive) | |
includedBusinessPartners | BPartner_Selection | Mandatory Max Length: 60 | java.lang.String | Business Partner Selection Mode is the way Business Partners will be selected. |
includedBPCategories | BP_Group_Selection | Mandatory Max Length: 60 | java.lang.String | Defines the way Business Partner Groups will be selected (including or excluding the taken ones) |
includedProducts | Product_Selection | Mandatory Max Length: 60 | java.lang.String | Defines the way Products will be selected (including or excluding the taken ones) |
includedProductCategories | Prod_Cat_Selection | Mandatory Max Length: 60 | java.lang.String | Defines the way Product Categories will be selected (including or excluding the taken ones) |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
includePriceLists | Pricelist_Selection | Max Length: 60 | java.lang.String | Defines the way Price Lists will be selected (including or excluding the taken ones) |
minQuantity | Qty_From | java.math.BigDecimal | Quantity From is the minimum amount that the offer will be applied from. | |
maxQuantity | Qty_To | java.math.BigDecimal | Quantity to is the maximum amount to apply the offer. | |
pricingAdjustmentBusinessPartnerGroupList | List of PricingAdjustmentBusinessPartnerGroup | |||
pricingAdjustmentPriceListList | List of PricingAdjustmentPriceList | |||
pricingAdjustmentProductCategoryList | List of PricingAdjustmentProductCategory | |||
pricingAdjustmentBusinessPartnerList | List of PricingAdjustmentBusinessPartner | |||
pricingAdjustmentProductList | List of PricingAdjustmentProduct |
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.pricing.priceadjustment; 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.enterprise.Organization; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.math.BigDecimal; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity PricingAdjustment (stored in table M_Offer). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class PriceAdjustment extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "M_Offer"; public static final String PricingAdjustment = "PricingAdjustment"; 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_NAME = "name"; public static final String PROPERTY_PRIORITY = "priority"; public static final String PROPERTY_DISCOUNTAMOUNT = "discountAmount"; public static final String PROPERTY_DISCOUNT = "discount"; public static final String PROPERTY_FIXEDPRICE = "fixedPrice"; public static final String PROPERTY_STARTINGDATE = "startingDate"; public static final String PROPERTY_ENDINGDATE = "endingDate"; public static final String PROPERTY_INCLUDEDBUSINESSPARTNERS = "includedBusinessPartners"; public static final String PROPERTY_INCLUDEDBPCATEGORIES = "includedBPCategories"; public static final String PROPERTY_INCLUDEDPRODUCTS = "includedProducts"; public static final String PROPERTY_INCLUDEDPRODUCTCATEGORIES = "includedProductCategories"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_INCLUDEPRICELISTS = "includePriceLists"; public static final String PROPERTY_MINQUANTITY = "minQuantity"; public static final String PROPERTY_MAXQUANTITY = "maxQuantity"; public static final String PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERGROUPLIST = "pricingAdjustmentBusinessPartnerGroupList"; public static final String PROPERTY_PRICINGADJUSTMENTPRICELISTLIST = "pricingAdjustmentPriceListList"; public static final String PROPERTY_PRICINGADJUSTMENTPRODUCTCATEGORYLIST = "pricingAdjustmentProductCategoryList"; public static final String PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERLIST = "pricingAdjustmentBusinessPartnerList"; public static final String PROPERTY_PRICINGADJUSTMENTPRODUCTLIST = "pricingAdjustmentProductList"; public PriceAdjustment() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_DISCOUNTAMOUNT, new BigDecimal(0)); setDefaultValue(PROPERTY_DISCOUNT, new BigDecimal(0)); setDefaultValue(PROPERTY_INCLUDEDBUSINESSPARTNERS, "Y"); setDefaultValue(PROPERTY_INCLUDEDBPCATEGORIES, "Y"); setDefaultValue(PROPERTY_INCLUDEDPRODUCTS, "Y"); setDefaultValue(PROPERTY_INCLUDEDPRODUCTCATEGORIES, "Y"); setDefaultValue(PROPERTY_INCLUDEPRICELISTS, "Y"); setDefaultValue(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERGROUPLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_PRICINGADJUSTMENTPRICELISTLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_PRICINGADJUSTMENTPRODUCTCATEGORYLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_PRICINGADJUSTMENTPRODUCTLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return PricingAdjustment; } 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 String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public Long getPriority() { return (Long) get(PROPERTY_PRIORITY); } public void setPriority(Long priority) { set(PROPERTY_PRIORITY, priority); } public BigDecimal getDiscountAmount() { return (BigDecimal) get(PROPERTY_DISCOUNTAMOUNT); } public void setDiscountAmount(BigDecimal discountAmount) { set(PROPERTY_DISCOUNTAMOUNT, discountAmount); } public BigDecimal getDiscount() { return (BigDecimal) get(PROPERTY_DISCOUNT); } public void setDiscount(BigDecimal discount) { set(PROPERTY_DISCOUNT, discount); } public BigDecimal getFixedPrice() { return (BigDecimal) get(PROPERTY_FIXEDPRICE); } public void setFixedPrice(BigDecimal fixedPrice) { set(PROPERTY_FIXEDPRICE, fixedPrice); } public Date getStartingDate() { return (Date) get(PROPERTY_STARTINGDATE); } public void setStartingDate(Date startingDate) { set(PROPERTY_STARTINGDATE, startingDate); } public Date getEndingDate() { return (Date) get(PROPERTY_ENDINGDATE); } public void setEndingDate(Date endingDate) { set(PROPERTY_ENDINGDATE, endingDate); } public String getIncludedBusinessPartners() { return (String) get(PROPERTY_INCLUDEDBUSINESSPARTNERS); } public void setIncludedBusinessPartners(String includedBusinessPartners) { set(PROPERTY_INCLUDEDBUSINESSPARTNERS, includedBusinessPartners); } public String getIncludedBPCategories() { return (String) get(PROPERTY_INCLUDEDBPCATEGORIES); } public void setIncludedBPCategories(String includedBPCategories) { set(PROPERTY_INCLUDEDBPCATEGORIES, includedBPCategories); } public String getIncludedProducts() { return (String) get(PROPERTY_INCLUDEDPRODUCTS); } public void setIncludedProducts(String includedProducts) { set(PROPERTY_INCLUDEDPRODUCTS, includedProducts); } public String getIncludedProductCategories() { return (String) get(PROPERTY_INCLUDEDPRODUCTCATEGORIES); } public void setIncludedProductCategories(String includedProductCategories) { set(PROPERTY_INCLUDEDPRODUCTCATEGORIES, includedProductCategories); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getIncludePriceLists() { return (String) get(PROPERTY_INCLUDEPRICELISTS); } public void setIncludePriceLists(String includePriceLists) { set(PROPERTY_INCLUDEPRICELISTS, includePriceLists); } public BigDecimal getMinQuantity() { return (BigDecimal) get(PROPERTY_MINQUANTITY); } public void setMinQuantity(BigDecimal minQuantity) { set(PROPERTY_MINQUANTITY, minQuantity); } public BigDecimal getMaxQuantity() { return (BigDecimal) get(PROPERTY_MAXQUANTITY); } public void setMaxQuantity(BigDecimal maxQuantity) { set(PROPERTY_MAXQUANTITY, maxQuantity); } @SuppressWarnings("unchecked") public List<BusinessPartnerGroup> getPricingAdjustmentBusinessPartnerGroupList() { return (List<BusinessPartnerGroup>) get(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERGROUPLIST); } public void setPricingAdjustmentBusinessPartnerGroupList( List<BusinessPartnerGroup> pricingAdjustmentBusinessPartnerGroupList) { set(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERGROUPLIST, pricingAdjustmentBusinessPartnerGroupList); } @SuppressWarnings("unchecked") public List<PriceList> getPricingAdjustmentPriceListList() { return (List<PriceList>) get(PROPERTY_PRICINGADJUSTMENTPRICELISTLIST); } public void setPricingAdjustmentPriceListList( List<PriceList> pricingAdjustmentPriceListList) { set(PROPERTY_PRICINGADJUSTMENTPRICELISTLIST, pricingAdjustmentPriceListList); } @SuppressWarnings("unchecked") public List<ProductCategory> getPricingAdjustmentProductCategoryList() { return (List<ProductCategory>) get(PROPERTY_PRICINGADJUSTMENTPRODUCTCATEGORYLIST); } public void setPricingAdjustmentProductCategoryList( List<ProductCategory> pricingAdjustmentProductCategoryList) { set(PROPERTY_PRICINGADJUSTMENTPRODUCTCATEGORYLIST, pricingAdjustmentProductCategoryList); } @SuppressWarnings("unchecked") public List<BusinessPartner> getPricingAdjustmentBusinessPartnerList() { return (List<BusinessPartner>) get(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERLIST); } public void setPricingAdjustmentBusinessPartnerList( List<BusinessPartner> pricingAdjustmentBusinessPartnerList) { set(PROPERTY_PRICINGADJUSTMENTBUSINESSPARTNERLIST, pricingAdjustmentBusinessPartnerList); } @SuppressWarnings("unchecked") public List<Product> getPricingAdjustmentProductList() { return (List<Product>) get(PROPERTY_PRICINGADJUSTMENTPRODUCTLIST); } public void setPricingAdjustmentProductList( List<Product> pricingAdjustmentProductList) { set(PROPERTY_PRICINGADJUSTMENTPRODUCTLIST, pricingAdjustmentProductList); } }