java.lang.Object
- org.openbravo.base.structure.BaseOBObject
- - org.openbravo.model.sales.Commission

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable
```
public class Commission
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
```
Entity class for entity SalesCommission (stored in table C_Commission).
Help: Contains all the commissions and when to pay a commission to whom. For each period, you start the calculation of the commission after the transaction for that period are completed or closed.
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider 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_Commission
`static String`	`PROPERTY_BASISAMT`	Property basisamt stored in column Basisamt in table C_Commission Help: The amount that will take into account to calculate the commission: net amount or margin. If margin is selected, only the invoices that have shipments will take into account.
`static String`	`PROPERTY_BASISSTATUS`	Property basisstatus stored in column Basisstatus in table C_Commission Help: The documents that will take into account to calculate the commission: all documents or fully paid documents)
`static String`	`PROPERTY_BUSINESSPARTNER`	Property businessPartner stored in column C_BPartner_ID in table C_Commission 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_CALCULATIONBASIS`	Property calculationBasis stored in column DocBasisType in table C_Commission Help: The Basis Document indicates the basis to be used for the commission calculation.
`static String`	`PROPERTY_CASCADE`	Property cascade stored in column iscascade in table C_Commission Help: If it is checked the commission will be calculated in cascade
`static String`	`PROPERTY_CLIENT`	Property client stored in column AD_Client_ID in table C_Commission
`static String`	`PROPERTY_CREATEDBY`	Property createdBy stored in column CreatedBy in table C_Commission
`static String`	`PROPERTY_CREATELINESFROM`	Property createLinesFrom stored in column CreateFrom in table C_Commission Help: A process that allows the user to copy lines (products) from an existing document different from the one being copied into. For example, in case of entering a new Goods Shipment, the user can copy lines (products) from an existing Sales Order or Sales Invoice.
`static String`	`PROPERTY_CREATIONDATE`	Property creationDate stored in column Created in table C_Commission
`static String`	`PROPERTY_CURRENCY`	Property currency stored in column C_Currency_ID in table C_Commission Help: Indicates the currency to be used when processing this document.
`static String`	`PROPERTY_DESCRIPTION`	Property description stored in column Description in table C_Commission Help: A description is limited to 255 characters.
`static String`	`PROPERTY_FREQUENCYTYPE`	Property frequencyType stored in column FrequencyType in table C_Commission Help: The frequency type is used for calculating the date of the next event.
`static String`	`PROPERTY_ID`	Property id stored in column C_Commission_ID in table C_Commission Help: The Commission ID is a unique identifier of a set of commission rules.
`static String`	`PROPERTY_LASTRUNDATE`	Property lastRunDate stored in column DateLastRun in table C_Commission Help: The Date Last Run indicates the last time that a process was run.
`static String`	`PROPERTY_LISTDETAILS`	Property listDetails stored in column ListDetails in table C_Commission Help: The List Details checkbox indicates that the details for each document line will be displayed.
`static String`	`PROPERTY_NAME`	Property name stored in column Name in table C_Commission
`static String`	`PROPERTY_ORGANIZATION`	Property organization stored in column AD_Org_ID in table C_Commission
`static String`	`PROPERTY_PROCESSNOW`	Property processNow stored in column Processing in table C_Commission Help: When this field is set as 'Y' a process is being performed on this record.
`static String`	`PROPERTY_PRODUCT`	Property product stored in column M_Product_ID in table C_Commission Help: Identifies an item which is either purchased or sold in this organization.
`static String`	`PROPERTY_SALESCOMMISSIONLINELIST`	Property salesCommissionLineList stored in table C_Commission
`static String`	`PROPERTY_UPDATED`	Property updated stored in column Updated in table C_Commission
`static String`	`PROPERTY_UPDATEDBY`	Property updatedBy stored in column UpdatedBy in table C_Commission
`static String`	`TABLE_NAME`

Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID

Constructor Summary

Constructors
Constructor Description

Commission()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getBasisamt()`
`String`	`getBasisstatus()`
`BusinessPartner`	`getBusinessPartner()`
`String`	`getCalculationBasis()`
`Client`	`getClient()`	Client field
`User`	`getCreatedBy()`	Created by audit user
`Date`	`getCreationDate()`	Creation date of audit
`Currency`	`getCurrency()`
`String`	`getDescription()`
`String`	`getEntityName()`
`String`	`getFrequencyType()`
`String`	`getId()`
`Date`	`getLastRunDate()`
`String`	`getName()`
`Organization`	`getOrganization()`	Gets organization field
`Product`	`getProduct()`
`List<CommissionLine>`	`getSalesCommissionLineList()`	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.
`Date`	`getUpdated()`	Update date of audit
`User`	`getUpdatedBy()`	Update by audit user
`Boolean`	`isActive()`	Gets active field
`Boolean`	`isCascade()`
`Boolean`	`isCreateLinesFrom()`
`Boolean`	`isListDetails()`
`Boolean`	`isProcessNow()`
`void`	`setActive(Boolean active)`	Sets active field
`void`	`setBasisamt(String basisamt)`
`void`	`setBasisstatus(String basisstatus)`
`void`	`setBusinessPartner(BusinessPartner businessPartner)`
`void`	`setCalculationBasis(String calculationBasis)`
`void`	`setCascade(Boolean cascade)`
`void`	`setClient(Client client)`	Client field
`void`	`setCreatedBy(User createdBy)`	Created by audit user
`void`	`setCreateLinesFrom(Boolean createLinesFrom)`
`void`	`setCreationDate(Date creationDate)`	Creation date of audit
`void`	`setCurrency(Currency currency)`
`void`	`setDescription(String description)`
`void`	`setFrequencyType(String frequencyType)`
`void`	`setId(String id)`
`void`	`setLastRunDate(Date lastRunDate)`
`void`	`setListDetails(Boolean listDetails)`
`void`	`setName(String name)`
`void`	`setOrganization(Organization organization)`	Sets organization field
`void`	`setProcessNow(Boolean processNow)`
`void`	`setProduct(Product product)`
`void`	`setSalesCommissionLineList(List<CommissionLine> salesCommissionLineList)`	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.
`void`	`setUpdated(Date updated)`	Update date of audit
`void`	`setUpdatedBy(User updatedBy)`	Update by audit user

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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_Commission_ID in table C_Commission
    Help: The Commission ID is a unique identifier of a set of commission rules.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CLIENT
```
public static final String PROPERTY_CLIENT
```
    Property client stored in column AD_Client_ID in table C_Commission
    
    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_Commission
    
    See Also:
    
    OrganizationEnabled, Constant Field Values
  - PROPERTY_ACTIVE
```
public static final String PROPERTY_ACTIVE
```
    Property active stored in column IsActive in table C_Commission
    
    See Also:
    
    ActiveEnabled, Constant Field Values
  - PROPERTY_CREATIONDATE
```
public static final String PROPERTY_CREATIONDATE
```
    Property creationDate stored in column Created in table C_Commission
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_CREATEDBY
```
public static final String PROPERTY_CREATEDBY
```
    Property createdBy stored in column CreatedBy in table C_Commission
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_UPDATED
```
public static final String PROPERTY_UPDATED
```
    Property updated stored in column Updated in table C_Commission
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_UPDATEDBY
```
public static final String PROPERTY_UPDATEDBY
```
    Property updatedBy stored in column UpdatedBy in table C_Commission
    
    See Also:
    
    Traceable, Constant Field Values
  - PROPERTY_NAME
```
public static final String PROPERTY_NAME
```
    Property name stored in column Name in table C_Commission
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DESCRIPTION
```
public static final String PROPERTY_DESCRIPTION
```
    Property description stored in column Description in table C_Commission
    Help: A description is limited to 255 characters.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BUSINESSPARTNER
```
public static final String PROPERTY_BUSINESSPARTNER
```
    Property businessPartner stored in column C_BPartner_ID in table C_Commission
    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_CURRENCY
```
public static final String PROPERTY_CURRENCY
```
    Property currency stored in column C_Currency_ID in table C_Commission
    Help: Indicates the currency to be used when processing this document.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_FREQUENCYTYPE
```
public static final String PROPERTY_FREQUENCYTYPE
```
    Property frequencyType stored in column FrequencyType in table C_Commission
    Help: The frequency type is used for calculating the date of the next event.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CALCULATIONBASIS
```
public static final String PROPERTY_CALCULATIONBASIS
```
    Property calculationBasis stored in column DocBasisType in table C_Commission
    Help: The Basis Document indicates the basis to be used for the commission calculation.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LISTDETAILS
```
public static final String PROPERTY_LISTDETAILS
```
    Property listDetails stored in column ListDetails in table C_Commission
    Help: The List Details checkbox indicates that the details for each document line will be displayed.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LASTRUNDATE
```
public static final String PROPERTY_LASTRUNDATE
```
    Property lastRunDate stored in column DateLastRun in table C_Commission
    Help: The Date Last Run indicates the last time that a process was run.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CREATELINESFROM
```
public static final String PROPERTY_CREATELINESFROM
```
    Property createLinesFrom stored in column CreateFrom in table C_Commission
    Help: A process that allows the user to copy lines (products) from an existing document different from the one being copied into. For example, in case of entering a new Goods Shipment, the user can copy lines (products) from an existing Sales Order or Sales Invoice.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PROCESSNOW
```
public static final String PROPERTY_PROCESSNOW
```
    Property processNow stored in column Processing in table C_Commission
    Help: When this field is set as 'Y' a process is being performed on this record.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PRODUCT
```
public static final String PROPERTY_PRODUCT
```
    Property product stored in column M_Product_ID in table C_Commission
    Help: Identifies an item which is either purchased or sold in this organization.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BASISSTATUS
```
public static final String PROPERTY_BASISSTATUS
```
    Property basisstatus stored in column Basisstatus in table C_Commission
    Help: The documents that will take into account to calculate the commission: all documents or fully paid documents)
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BASISAMT
```
public static final String PROPERTY_BASISAMT
```
    Property basisamt stored in column Basisamt in table C_Commission
    Help: The amount that will take into account to calculate the commission: net amount or margin. If margin is selected, only the invoices that have shipments will take into account.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CASCADE
```
public static final String PROPERTY_CASCADE
```
    Property cascade stored in column iscascade in table C_Commission
    Help: If it is checked the commission will be calculated in cascade
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SALESCOMMISSIONLINELIST
```
public static final String PROPERTY_SALESCOMMISSIONLINELIST
```
    Property salesCommissionLineList stored in table C_Commission
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Commission
```
public Commission()
```
- Method Detail
  - getEntityName
```
public String getEntityName()
```
    Specified by:
    
    getEntityName in interface Identifiable
    
    Specified by:
    
    getEntityName in class BaseOBObject
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface BaseOBObjectDef
    
    Specified by:
    
    getId in interface Identifiable
    
    Overrides:
    
    getId in class BaseOBObject
    
    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 interface ClientEnabled
    
    Returns:
    
    client
    
    See Also:
    
    PROPERTY_CLIENT
  - setClient
```
public void setClient(Client client)
```
    Description copied from interface: ClientEnabled
    
    Client field
    
    Specified by:
    
    setClient in interface ClientEnabled
    
    See Also:
    
    PROPERTY_CLIENT
  - getOrganization
```
public Organization getOrganization()
```
    Description copied from interface: OrganizationEnabled
    
    Gets organization field
    
    Specified by:
    
    getOrganization in interface OrganizationEnabled
    
    Returns:
    
    organization
    
    See Also:
    
    PROPERTY_ORGANIZATION
  - setOrganization
```
public void setOrganization(Organization organization)
```
    Description copied from interface: OrganizationEnabled
    
    Sets organization field
    
    Specified by:
    
    setOrganization in interface OrganizationEnabled
    
    See Also:
    
    PROPERTY_ORGANIZATION
  - isActive
```
public Boolean isActive()
```
    Description copied from interface: ActiveEnabled
    
    Gets active field
    
    Specified by:
    
    isActive in interface ActiveEnabled
    
    Returns:
    
    active
    
    See Also:
    
    PROPERTY_ACTIVE
  - setActive
```
public void setActive(Boolean active)
```
    Description copied from interface: ActiveEnabled
    
    Sets active field
    
    Specified by:
    
    setActive in interface ActiveEnabled
    
    See Also:
    
    PROPERTY_ACTIVE
  - getCreationDate
```
public Date getCreationDate()
```
    Description copied from interface: Traceable
    
    Creation date of audit
    
    Specified by:
    
    getCreationDate in interface Traceable
    
    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 interface Traceable
    
    See Also:
    
    PROPERTY_CREATIONDATE
  - getCreatedBy
```
public User getCreatedBy()
```
    Description copied from interface: Traceable
    
    Created by audit user
    
    Specified by:
    
    getCreatedBy in interface Traceable
    
    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 interface Traceable
    
    See Also:
    
    PROPERTY_CREATEDBY
  - getUpdated
```
public Date getUpdated()
```
    Description copied from interface: Traceable
    
    Update date of audit
    
    Specified by:
    
    getUpdated in interface Traceable
    
    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 interface Traceable
    
    See Also:
    
    PROPERTY_UPDATED
  - getUpdatedBy
```
public User getUpdatedBy()
```
    Description copied from interface: Traceable
    
    Update by audit user
    
    Specified by:
    
    getUpdatedBy in interface Traceable
    
    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 interface Traceable
    
    See Also:
    
    PROPERTY_UPDATEDBY
  - getName
```
public String getName()
```
    See Also:
    
    PROPERTY_NAME
  - setName
```
public void setName(String name)
```
    See Also:
    
    PROPERTY_NAME
  - getDescription
```
public String getDescription()
```
    See Also:
    
    PROPERTY_DESCRIPTION
  - setDescription
```
public void setDescription(String description)
```
    See Also:
    
    PROPERTY_DESCRIPTION
  - getBusinessPartner
```
public BusinessPartner getBusinessPartner()
```
    See Also:
    
    PROPERTY_BUSINESSPARTNER
  - setBusinessPartner
```
public void setBusinessPartner(BusinessPartner businessPartner)
```
    See Also:
    
    PROPERTY_BUSINESSPARTNER
  - getCurrency
```
public Currency getCurrency()
```
    See Also:
    
    PROPERTY_CURRENCY
  - setCurrency
```
public void setCurrency(Currency currency)
```
    See Also:
    
    PROPERTY_CURRENCY
  - getFrequencyType
```
public String getFrequencyType()
```
    See Also:
    
    PROPERTY_FREQUENCYTYPE
  - setFrequencyType
```
public void setFrequencyType(String frequencyType)
```
    See Also:
    
    PROPERTY_FREQUENCYTYPE
  - getCalculationBasis
```
public String getCalculationBasis()
```
    See Also:
    
    PROPERTY_CALCULATIONBASIS
  - setCalculationBasis
```
public void setCalculationBasis(String calculationBasis)
```
    See Also:
    
    PROPERTY_CALCULATIONBASIS
  - isListDetails
```
public Boolean isListDetails()
```
    See Also:
    
    PROPERTY_LISTDETAILS
  - setListDetails
```
public void setListDetails(Boolean listDetails)
```
    See Also:
    
    PROPERTY_LISTDETAILS
  - getLastRunDate
```
public Date getLastRunDate()
```
    See Also:
    
    PROPERTY_LASTRUNDATE
  - setLastRunDate
```
public void setLastRunDate(Date lastRunDate)
```
    See Also:
    
    PROPERTY_LASTRUNDATE
  - isCreateLinesFrom
```
public Boolean isCreateLinesFrom()
```
    See Also:
    
    PROPERTY_CREATELINESFROM
  - setCreateLinesFrom
```
public void setCreateLinesFrom(Boolean createLinesFrom)
```
    See Also:
    
    PROPERTY_CREATELINESFROM
  - isProcessNow
```
public Boolean isProcessNow()
```
    See Also:
    
    PROPERTY_PROCESSNOW
  - setProcessNow
```
public void setProcessNow(Boolean processNow)
```
    See Also:
    
    PROPERTY_PROCESSNOW
  - getProduct
```
public Product getProduct()
```
    See Also:
    
    PROPERTY_PRODUCT
  - setProduct
```
public void setProduct(Product product)
```
    See Also:
    
    PROPERTY_PRODUCT
  - getBasisstatus
```
public String getBasisstatus()
```
    See Also:
    
    PROPERTY_BASISSTATUS
  - setBasisstatus
```
public void setBasisstatus(String basisstatus)
```
    See Also:
    
    PROPERTY_BASISSTATUS
  - getBasisamt
```
public String getBasisamt()
```
    See Also:
    
    PROPERTY_BASISAMT
  - setBasisamt
```
public void setBasisamt(String basisamt)
```
    See Also:
    
    PROPERTY_BASISAMT
  - isCascade
```
public Boolean isCascade()
```
    See Also:
    
    PROPERTY_CASCADE
  - setCascade
```
public void setCascade(Boolean cascade)
```
    See Also:
    
    PROPERTY_CASCADE
  - getSalesCommissionLineList
```
public List<CommissionLine> getSalesCommissionLineList()
```
    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.
    
    See Also:
    
    CommissionLine
  - setSalesCommissionLineList
```
public void setSalesCommissionLineList(List<CommissionLine> salesCommissionLineList)
```
    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.
    
    See Also:
    
    CommissionLine

Class Commission

Field Summary

Fields inherited from class org.openbravo.base.structure.BaseOBObject

Constructor Summary

Method Summary

Methods inherited from class org.openbravo.base.structure.BaseOBObject

Methods inherited from class java.lang.Object

Field Detail

TABLE_NAME

ENTITY_NAME

PROPERTY_ID

PROPERTY_CLIENT

PROPERTY_ORGANIZATION

PROPERTY_ACTIVE

PROPERTY_CREATIONDATE

PROPERTY_CREATEDBY

PROPERTY_UPDATED

PROPERTY_UPDATEDBY

PROPERTY_NAME

PROPERTY_DESCRIPTION

PROPERTY_BUSINESSPARTNER

PROPERTY_CURRENCY

PROPERTY_FREQUENCYTYPE

PROPERTY_CALCULATIONBASIS

PROPERTY_LISTDETAILS

PROPERTY_LASTRUNDATE

PROPERTY_CREATELINESFROM

PROPERTY_PROCESSNOW

PROPERTY_PRODUCT

PROPERTY_BASISSTATUS

PROPERTY_BASISAMT

PROPERTY_CASCADE

PROPERTY_SALESCOMMISSIONLINELIST

Constructor Detail

Commission

Method Detail

getEntityName

getId

setId

getClient

setClient

getOrganization

setOrganization

isActive

setActive

getCreationDate

setCreationDate

getCreatedBy

setCreatedBy

getUpdated

setUpdated

getUpdatedBy

setUpdatedBy

getName

setName

getDescription

setDescription

getBusinessPartner

setBusinessPartner

getCurrency

setCurrency

getFrequencyType

setFrequencyType

getCalculationBasis

setCalculationBasis

isListDetails

setListDetails

getLastRunDate

setLastRunDate

isCreateLinesFrom

setCreateLinesFrom

isProcessNow

setProcessNow

getProduct

setProduct

getBasisstatus

setBasisstatus

getBasisamt

setBasisamt

isCascade