Package org.openbravo.model.sales
Class CommissionLine
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.sales.CommissionLine
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class CommissionLine extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity SalesCommissionLine (stored in table C_CommissionLine).
Help: Define the selection criteria for paying the commission. If you do not enter restricting parameters (e.g. for specific Business Partner (Groups) or Product (Categories), etc. all transactions for the period will be used to calculate the commission.
NOTE: This class should not be instantiated directly. To instantiate this class theOBProvider
should be used.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
ENTITY_NAME
static String
PROPERTY_ACTIVE
Property active stored in column IsActive in table C_CommissionLinestatic String
PROPERTY_BUSINESSPARTNER
Property businessPartner stored in column C_BPartner_ID in table C_CommissionLine
Help: A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these.static String
PROPERTY_BUSINESSPARTNERCATEGORY
Property businessPartnerCategory stored in column C_BP_Group_ID in table C_CommissionLine
Help: A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners.static String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_CommissionLinestatic String
PROPERTY_COMMISSION
Property commission stored in column C_Commission_ID in table C_CommissionLine
Help: The Commission ID is a unique identifier of a set of commission rules.static String
PROPERTY_COMMISSIONONLYSPECIFIEDORDERS
Property commissionOnlySpecifiedOrders stored in column CommissionOrders in table C_CommissionLine
Help: Sales Reps are entered in Orders and Invoices. If selected, only Orders and Invoices for this Sales Reps are included in the calculation of the commission.static String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_CommissionLinestatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_CommissionLinestatic String
PROPERTY_DESCRIPTION
Property description stored in column Description in table C_CommissionLine
Help: A description is limited to 255 characters.static String
PROPERTY_EXCLUDE
Property exclude stored in column Exclude in table C_CommissionLine
Help: If exclude is checked, the lines that satisfied the conditions specified in the current line will be excluded in commission calculation. The check box Cascade must be checked for being able to exclude lines.static String
PROPERTY_ID
Property id stored in column C_CommissionLine_ID in table C_CommissionLine
Help: The Commission Line is a unique instance of a Commission Run. If the commission run was done in summary mode then there will be a single line representing the selected documents totals. If the commission run was done in detail mode then each document that was included in the run will have its own commission line.static String
PROPERTY_LINENO
Property lineNo stored in column Line in table C_CommissionLinestatic String
PROPERTY_MULTIPLIERAMOUNT
Property multiplierAmount stored in column AmtMultiplier in table C_CommissionLine
Help: The Multiplier Amount indicates the amount to multiply the total amount generated by this commission run by.static String
PROPERTY_MULTIPLIERQUANTITY
Property multiplierQuantity stored in column QtyMultiplier in table C_CommissionLine
Help: The Multiplier Quantity field indicates the amount to multiply the quantities accumulated for this commission run.static String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table C_CommissionLinestatic String
PROPERTY_POSITIVEONLY
Property positiveOnly stored in column IsPositiveOnly in table C_CommissionLine
Help: The Positive Only check box indicates that if the result of the subtraction is negative, it is ignored. This would mean that negative commissions would not be generated.static String
PROPERTY_PRODUCT
Property product stored in column M_Product_ID in table C_CommissionLine
Help: Identifies an item which is either purchased or sold in this organization.static String
PROPERTY_PRODUCTCATEGORY
Property productCategory stored in column M_Product_Category_ID in table C_CommissionLine
Help: Identifies the category which this product belongs to. Product categories are used for pricing.static String
PROPERTY_SALESREGION
Property salesRegion stored in column C_SalesRegion_ID in table C_CommissionLine
Help: The Sales Region indicates a specific area of sales coverage.static String
PROPERTY_SUBTRACTAMOUNT
Property subtractAmount stored in column AmtSubtract in table C_CommissionLine
Help: The Subtract Amount indicates the amount to subtract from the total amount prior to multiplication.static String
PROPERTY_SUBTRACTQUANTITY
Property subtractQuantity stored in column QtySubtract in table C_CommissionLine
Help: The Quantity Subtract identifies the quantity to be subtracted before multiplicationstatic String
PROPERTY_TRXORGANIZATION
Property trxOrganization stored in column Org_ID in table C_CommissionLine
Help: An organization is a unit of your client or legal entity - examples are store, department.static String
PROPERTY_UPDATED
Property updated stored in column Updated in table C_CommissionLinestatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_CommissionLinestatic String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description CommissionLine()
-
Method Summary
-
Methods inherited from class org.openbravo.base.structure.BaseOBObject
checkDerivedReadable, get, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate
-
-
-
-
Field Detail
-
TABLE_NAME
public static final String TABLE_NAME
- See Also:
- Constant Field Values
-
ENTITY_NAME
public static final String ENTITY_NAME
- See Also:
- Constant Field Values
-
PROPERTY_ID
public static final String PROPERTY_ID
Property id stored in column C_CommissionLine_ID in table C_CommissionLine
Help: The Commission Line is a unique instance of a Commission Run. If the commission run was done in summary mode then there will be a single line representing the selected documents totals. If the commission run was done in detail mode then each document that was included in the run will have its own commission line.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_CommissionLine- See Also:
ClientEnabled
, Constant Field Values
-
PROPERTY_ORGANIZATION
public static final String PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table C_CommissionLine- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table C_CommissionLine- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_CommissionLine- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_CommissionLine- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table C_CommissionLine- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_CommissionLine- See Also:
Traceable
, Constant Field Values
-
PROPERTY_COMMISSION
public static final String PROPERTY_COMMISSION
Property commission stored in column C_Commission_ID in table C_CommissionLine
Help: The Commission ID is a unique identifier of a set of commission rules.- See Also:
- Constant Field Values
-
PROPERTY_LINENO
public static final String PROPERTY_LINENO
Property lineNo stored in column Line in table C_CommissionLine- See Also:
- Constant Field Values
-
PROPERTY_DESCRIPTION
public static final String PROPERTY_DESCRIPTION
Property description stored in column Description in table C_CommissionLine
Help: A description is limited to 255 characters.- See Also:
- Constant Field Values
-
PROPERTY_SUBTRACTAMOUNT
public static final String PROPERTY_SUBTRACTAMOUNT
Property subtractAmount stored in column AmtSubtract in table C_CommissionLine
Help: The Subtract Amount indicates the amount to subtract from the total amount prior to multiplication.- See Also:
- Constant Field Values
-
PROPERTY_MULTIPLIERAMOUNT
public static final String PROPERTY_MULTIPLIERAMOUNT
Property multiplierAmount stored in column AmtMultiplier in table C_CommissionLine
Help: The Multiplier Amount indicates the amount to multiply the total amount generated by this commission run by.- See Also:
- Constant Field Values
-
PROPERTY_SUBTRACTQUANTITY
public static final String PROPERTY_SUBTRACTQUANTITY
Property subtractQuantity stored in column QtySubtract in table C_CommissionLine
Help: The Quantity Subtract identifies the quantity to be subtracted before multiplication- See Also:
- Constant Field Values
-
PROPERTY_MULTIPLIERQUANTITY
public static final String PROPERTY_MULTIPLIERQUANTITY
Property multiplierQuantity stored in column QtyMultiplier in table C_CommissionLine
Help: The Multiplier Quantity field indicates the amount to multiply the quantities accumulated for this commission run.- See Also:
- Constant Field Values
-
PROPERTY_POSITIVEONLY
public static final String PROPERTY_POSITIVEONLY
Property positiveOnly stored in column IsPositiveOnly in table C_CommissionLine
Help: The Positive Only check box indicates that if the result of the subtraction is negative, it is ignored. This would mean that negative commissions would not be generated.- See Also:
- Constant Field Values
-
PROPERTY_COMMISSIONONLYSPECIFIEDORDERS
public static final String PROPERTY_COMMISSIONONLYSPECIFIEDORDERS
Property commissionOnlySpecifiedOrders stored in column CommissionOrders in table C_CommissionLine
Help: Sales Reps are entered in Orders and Invoices. If selected, only Orders and Invoices for this Sales Reps are included in the calculation of the commission.- See Also:
- Constant Field Values
-
PROPERTY_TRXORGANIZATION
public static final String PROPERTY_TRXORGANIZATION
Property trxOrganization stored in column Org_ID in table C_CommissionLine
Help: An organization is a unit of your client or legal entity - examples are store, department.- See Also:
- Constant Field Values
-
PROPERTY_PRODUCTCATEGORY
public static final String PROPERTY_PRODUCTCATEGORY
Property productCategory stored in column M_Product_Category_ID in table C_CommissionLine
Help: Identifies the category which this product belongs to. Product categories are used for pricing.- See Also:
- Constant Field Values
-
PROPERTY_PRODUCT
public static final String PROPERTY_PRODUCT
Property product stored in column M_Product_ID in table C_CommissionLine
Help: Identifies an item which is either purchased or sold in this organization.- See Also:
- Constant Field Values
-
PROPERTY_BUSINESSPARTNERCATEGORY
public static final String PROPERTY_BUSINESSPARTNERCATEGORY
Property businessPartnerCategory stored in column C_BP_Group_ID in table C_CommissionLine
Help: A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners.- See Also:
- Constant Field Values
-
PROPERTY_BUSINESSPARTNER
public static final String PROPERTY_BUSINESSPARTNER
Property businessPartner stored in column C_BPartner_ID in table C_CommissionLine
Help: A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these.- See Also:
- Constant Field Values
-
PROPERTY_SALESREGION
public static final String PROPERTY_SALESREGION
Property salesRegion stored in column C_SalesRegion_ID in table C_CommissionLine
Help: The Sales Region indicates a specific area of sales coverage.- See Also:
- Constant Field Values
-
PROPERTY_EXCLUDE
public static final String PROPERTY_EXCLUDE
Property exclude stored in column Exclude in table C_CommissionLine
Help: If exclude is checked, the lines that satisfied the conditions specified in the current line will be excluded in commission calculation. The check box Cascade must be checked for being able to exclude lines.- See Also:
- Constant Field Values
-
-
Method Detail
-
getEntityName
public String getEntityName()
- Specified by:
getEntityName
in interfaceIdentifiable
- Specified by:
getEntityName
in classBaseOBObject
-
getId
public String getId()
- Specified by:
getId
in interfaceBaseOBObjectDef
- Specified by:
getId
in interfaceIdentifiable
- Overrides:
getId
in classBaseOBObject
- See Also:
PROPERTY_ID
-
setId
public void setId(String id)
- See Also:
PROPERTY_ID
-
getClient
public Client getClient()
Description copied from interface:ClientEnabled
Client field- Specified by:
getClient
in interfaceClientEnabled
- Returns:
- client
- See Also:
PROPERTY_CLIENT
-
setClient
public void setClient(Client client)
Description copied from interface:ClientEnabled
Client field- Specified by:
setClient
in interfaceClientEnabled
- See Also:
PROPERTY_CLIENT
-
getOrganization
public Organization getOrganization()
Description copied from interface:OrganizationEnabled
Gets organization field- Specified by:
getOrganization
in interfaceOrganizationEnabled
- Returns:
- organization
- See Also:
PROPERTY_ORGANIZATION
-
setOrganization
public void setOrganization(Organization organization)
Description copied from interface:OrganizationEnabled
Sets organization field- Specified by:
setOrganization
in interfaceOrganizationEnabled
- See Also:
PROPERTY_ORGANIZATION
-
isActive
public Boolean isActive()
Description copied from interface:ActiveEnabled
Gets active field- Specified by:
isActive
in interfaceActiveEnabled
- Returns:
- active
- See Also:
PROPERTY_ACTIVE
-
setActive
public void setActive(Boolean active)
Description copied from interface:ActiveEnabled
Sets active field- Specified by:
setActive
in interfaceActiveEnabled
- See Also:
PROPERTY_ACTIVE
-
getCreationDate
public Date getCreationDate()
Description copied from interface:Traceable
Creation date of audit- Specified by:
getCreationDate
in interfaceTraceable
- Returns:
- Date of creation
- See Also:
PROPERTY_CREATIONDATE
-
setCreationDate
public void setCreationDate(Date creationDate)
Description copied from interface:Traceable
Creation date of audit- Specified by:
setCreationDate
in interfaceTraceable
- See Also:
PROPERTY_CREATIONDATE
-
getCreatedBy
public User getCreatedBy()
Description copied from interface:Traceable
Created by audit user- Specified by:
getCreatedBy
in interfaceTraceable
- Returns:
- User
- See Also:
PROPERTY_CREATEDBY
-
setCreatedBy
public void setCreatedBy(User createdBy)
Description copied from interface:Traceable
Created by audit user- Specified by:
setCreatedBy
in interfaceTraceable
- See Also:
PROPERTY_CREATEDBY
-
getUpdated
public Date getUpdated()
Description copied from interface:Traceable
Update date of audit- Specified by:
getUpdated
in interfaceTraceable
- Returns:
- Date of update
- See Also:
PROPERTY_UPDATED
-
setUpdated
public void setUpdated(Date updated)
Description copied from interface:Traceable
Update date of audit- Specified by:
setUpdated
in interfaceTraceable
- See Also:
PROPERTY_UPDATED
-
getUpdatedBy
public User getUpdatedBy()
Description copied from interface:Traceable
Update by audit user- Specified by:
getUpdatedBy
in interfaceTraceable
- Returns:
- User who updated
- See Also:
PROPERTY_UPDATEDBY
-
setUpdatedBy
public void setUpdatedBy(User updatedBy)
Description copied from interface:Traceable
Update by audit user- Specified by:
setUpdatedBy
in interfaceTraceable
- See Also:
PROPERTY_UPDATEDBY
-
getCommission
public Commission getCommission()
- See Also:
PROPERTY_COMMISSION
-
setCommission
public void setCommission(Commission commission)
- See Also:
PROPERTY_COMMISSION
-
getLineNo
public Long getLineNo()
- See Also:
PROPERTY_LINENO
-
setLineNo
public void setLineNo(Long lineNo)
- See Also:
PROPERTY_LINENO
-
getDescription
public String getDescription()
- See Also:
PROPERTY_DESCRIPTION
-
setDescription
public void setDescription(String description)
- See Also:
PROPERTY_DESCRIPTION
-
getSubtractAmount
public BigDecimal getSubtractAmount()
- See Also:
PROPERTY_SUBTRACTAMOUNT
-
setSubtractAmount
public void setSubtractAmount(BigDecimal subtractAmount)
- See Also:
PROPERTY_SUBTRACTAMOUNT
-
getMultiplierAmount
public BigDecimal getMultiplierAmount()
- See Also:
PROPERTY_MULTIPLIERAMOUNT
-
setMultiplierAmount
public void setMultiplierAmount(BigDecimal multiplierAmount)
- See Also:
PROPERTY_MULTIPLIERAMOUNT
-
getSubtractQuantity
public BigDecimal getSubtractQuantity()
- See Also:
PROPERTY_SUBTRACTQUANTITY
-
setSubtractQuantity
public void setSubtractQuantity(BigDecimal subtractQuantity)
- See Also:
PROPERTY_SUBTRACTQUANTITY
-
getMultiplierQuantity
public BigDecimal getMultiplierQuantity()
- See Also:
PROPERTY_MULTIPLIERQUANTITY
-
setMultiplierQuantity
public void setMultiplierQuantity(BigDecimal multiplierQuantity)
- See Also:
PROPERTY_MULTIPLIERQUANTITY
-
isPositiveOnly
public Boolean isPositiveOnly()
- See Also:
PROPERTY_POSITIVEONLY
-
setPositiveOnly
public void setPositiveOnly(Boolean positiveOnly)
- See Also:
PROPERTY_POSITIVEONLY
-
isCommissionOnlySpecifiedOrders
public Boolean isCommissionOnlySpecifiedOrders()
- See Also:
PROPERTY_COMMISSIONONLYSPECIFIEDORDERS
-
setCommissionOnlySpecifiedOrders
public void setCommissionOnlySpecifiedOrders(Boolean commissionOnlySpecifiedOrders)
- See Also:
PROPERTY_COMMISSIONONLYSPECIFIEDORDERS
-
getTrxOrganization
public Organization getTrxOrganization()
- See Also:
PROPERTY_TRXORGANIZATION
-
setTrxOrganization
public void setTrxOrganization(Organization trxOrganization)
- See Also:
PROPERTY_TRXORGANIZATION
-
getProductCategory
public ProductCategory getProductCategory()
- See Also:
PROPERTY_PRODUCTCATEGORY
-
setProductCategory
public void setProductCategory(ProductCategory productCategory)
- See Also:
PROPERTY_PRODUCTCATEGORY
-
getProduct
public Product getProduct()
- See Also:
PROPERTY_PRODUCT
-
setProduct
public void setProduct(Product product)
- See Also:
PROPERTY_PRODUCT
-
getBusinessPartnerCategory
public Category getBusinessPartnerCategory()
- See Also:
PROPERTY_BUSINESSPARTNERCATEGORY
-
setBusinessPartnerCategory
public void setBusinessPartnerCategory(Category businessPartnerCategory)
- See Also:
PROPERTY_BUSINESSPARTNERCATEGORY
-
getBusinessPartner
public BusinessPartner getBusinessPartner()
- See Also:
PROPERTY_BUSINESSPARTNER
-
setBusinessPartner
public void setBusinessPartner(BusinessPartner businessPartner)
- See Also:
PROPERTY_BUSINESSPARTNER
-
getSalesRegion
public SalesRegion getSalesRegion()
- See Also:
PROPERTY_SALESREGION
-
setSalesRegion
public void setSalesRegion(SalesRegion salesRegion)
- See Also:
PROPERTY_SALESREGION
-
isExclude
public Boolean isExclude()
- See Also:
PROPERTY_EXCLUDE
-
setExclude
public void setExclude(Boolean exclude)
- See Also:
PROPERTY_EXCLUDE
-
-