Package org.openbravo.model.sales
Class CommissionAmount
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.sales.CommissionAmount
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class CommissionAmount extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity SalesCommissionAmount (stored in table C_CommissionAmt).
Help: Contains all the commission lines amounts
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_CommissionAmtstatic String
PROPERTY_ACTUALQUANTITY
Property actualQuantity stored in column ActualQty in table C_CommissionAmt
Help: The Actual Quantity indicates the quantity as referenced on a document.static String
PROPERTY_AMOUNT
Property amount stored in column CommissionAmt in table C_CommissionAmt
Help: The Commission Amount is the total calculated commission. It is based on the parameters as defined for this Commission Run.static String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_CommissionAmtstatic String
PROPERTY_COMMISSIONLINE
Property commissionLine stored in column C_CommissionLine_ID in table C_CommissionAmt
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_COMMISSIONRUN
Property commissionRun stored in column C_CommissionRun_ID in table C_CommissionAmt
Help: The Commission Run is a unique system defined identifier of a specific run of commission. When a Commission is processed on the Commission Screen, the Commission Run ID will display.static String
PROPERTY_CONVERTEDAMOUNT
Property convertedAmount stored in column ConvertedAmt in table C_CommissionAmt
Help: The Converted Amount is the result of multiplying the Source Amount by the Conversion Rate for this target currency.static String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_CommissionAmtstatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_CommissionAmtstatic String
PROPERTY_ID
Property id stored in column C_CommissionAmt_ID in table C_CommissionAmt
Help: The Commission Amount indicates the resulting amount from a Commission Run.static String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table C_CommissionAmtstatic String
PROPERTY_SALESCOMMISSIONDETAILLIST
Property salesCommissionDetailList stored in table C_CommissionAmtstatic String
PROPERTY_UPDATED
Property updated stored in column Updated in table C_CommissionAmtstatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_CommissionAmtstatic String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description CommissionAmount()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BigDecimal
getActualQuantity()
BigDecimal
getAmount()
Client
getClient()
Client fieldCommissionLine
getCommissionLine()
CommissionRun
getCommissionRun()
BigDecimal
getConvertedAmount()
User
getCreatedBy()
Created by audit userDate
getCreationDate()
Creation date of auditString
getEntityName()
String
getId()
Organization
getOrganization()
Gets organization fieldList<CommissionDetail>
getSalesCommissionDetailList()
Help: You may alter the amount and quantity of the detail records, but the suggested way is to add new correcting lines. The amounts are converted from the transaction currency to the Commission Currency (defined in the Commission window)Date
getUpdated()
Update date of auditUser
getUpdatedBy()
Update by audit userBoolean
isActive()
Gets active fieldvoid
setActive(Boolean active)
Sets active fieldvoid
setActualQuantity(BigDecimal actualQuantity)
void
setAmount(BigDecimal amount)
void
setClient(Client client)
Client fieldvoid
setCommissionLine(CommissionLine commissionLine)
void
setCommissionRun(CommissionRun commissionRun)
void
setConvertedAmount(BigDecimal convertedAmount)
void
setCreatedBy(User createdBy)
Created by audit uservoid
setCreationDate(Date creationDate)
Creation date of auditvoid
setId(String id)
void
setOrganization(Organization organization)
Sets organization fieldvoid
setSalesCommissionDetailList(List<CommissionDetail> salesCommissionDetailList)
Help: You may alter the amount and quantity of the detail records, but the suggested way is to add new correcting lines. The amounts are converted from the transaction currency to the Commission Currency (defined in the Commission window)void
setUpdated(Date updated)
Update date of auditvoid
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
-
-
-
-
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_CommissionAmt_ID in table C_CommissionAmt
Help: The Commission Amount indicates the resulting amount from a Commission Run.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_CommissionAmt- 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_CommissionAmt- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table C_CommissionAmt- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_CommissionAmt- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_CommissionAmt- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table C_CommissionAmt- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_CommissionAmt- See Also:
Traceable
, Constant Field Values
-
PROPERTY_COMMISSIONRUN
public static final String PROPERTY_COMMISSIONRUN
Property commissionRun stored in column C_CommissionRun_ID in table C_CommissionAmt
Help: The Commission Run is a unique system defined identifier of a specific run of commission. When a Commission is processed on the Commission Screen, the Commission Run ID will display.- See Also:
- Constant Field Values
-
PROPERTY_COMMISSIONLINE
public static final String PROPERTY_COMMISSIONLINE
Property commissionLine stored in column C_CommissionLine_ID in table C_CommissionAmt
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_CONVERTEDAMOUNT
public static final String PROPERTY_CONVERTEDAMOUNT
Property convertedAmount stored in column ConvertedAmt in table C_CommissionAmt
Help: The Converted Amount is the result of multiplying the Source Amount by the Conversion Rate for this target currency.- See Also:
- Constant Field Values
-
PROPERTY_ACTUALQUANTITY
public static final String PROPERTY_ACTUALQUANTITY
Property actualQuantity stored in column ActualQty in table C_CommissionAmt
Help: The Actual Quantity indicates the quantity as referenced on a document.- See Also:
- Constant Field Values
-
PROPERTY_AMOUNT
public static final String PROPERTY_AMOUNT
Property amount stored in column CommissionAmt in table C_CommissionAmt
Help: The Commission Amount is the total calculated commission. It is based on the parameters as defined for this Commission Run.- See Also:
- Constant Field Values
-
PROPERTY_SALESCOMMISSIONDETAILLIST
public static final String PROPERTY_SALESCOMMISSIONDETAILLIST
Property salesCommissionDetailList stored in table C_CommissionAmt- 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
-
getCommissionRun
public CommissionRun getCommissionRun()
- See Also:
PROPERTY_COMMISSIONRUN
-
setCommissionRun
public void setCommissionRun(CommissionRun commissionRun)
- See Also:
PROPERTY_COMMISSIONRUN
-
getCommissionLine
public CommissionLine getCommissionLine()
- See Also:
PROPERTY_COMMISSIONLINE
-
setCommissionLine
public void setCommissionLine(CommissionLine commissionLine)
- See Also:
PROPERTY_COMMISSIONLINE
-
getConvertedAmount
public BigDecimal getConvertedAmount()
- See Also:
PROPERTY_CONVERTEDAMOUNT
-
setConvertedAmount
public void setConvertedAmount(BigDecimal convertedAmount)
- See Also:
PROPERTY_CONVERTEDAMOUNT
-
getActualQuantity
public BigDecimal getActualQuantity()
- See Also:
PROPERTY_ACTUALQUANTITY
-
setActualQuantity
public void setActualQuantity(BigDecimal actualQuantity)
- See Also:
PROPERTY_ACTUALQUANTITY
-
getAmount
public BigDecimal getAmount()
- See Also:
PROPERTY_AMOUNT
-
setAmount
public void setAmount(BigDecimal amount)
- See Also:
PROPERTY_AMOUNT
-
getSalesCommissionDetailList
public List<CommissionDetail> getSalesCommissionDetailList()
Help: You may alter the amount and quantity of the detail records, but the suggested way is to add new correcting lines. The amounts are converted from the transaction currency to the Commission Currency (defined in the Commission window)- See Also:
CommissionDetail
-
setSalesCommissionDetailList
public void setSalesCommissionDetailList(List<CommissionDetail> salesCommissionDetailList)
Help: You may alter the amount and quantity of the detail records, but the suggested way is to add new correcting lines. The amounts are converted from the transaction currency to the Commission Currency (defined in the Commission window)- See Also:
CommissionDetail
-
-