public class MiscellaneousCharge extends ModelObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String | INVALID_UID
Initial unique identifier assigned to the miscellaneous charge which is an invalid number (-00000000).
|
static java.lang.String | PROP_AMOUNT
Constant for the amount property name.
|
static java.lang.String | PROP_CURRENCY
Constant for the currency property name.
|
static java.lang.String | PROP_DESCRIPTION
Constant for the description property name.
|
static java.lang.String | PROP_FORMATTED_AMOUNT
Constant for the formatted amount property name.
|
static java.lang.String | PROP_PRODUCT_CODE
Constant for the product code.
|
static java.lang.String | PROP_PROMOTION_CODE
Constant for the promotion code property name.
|
static java.lang.String | PROP_UID
Constant for the "uid" property name.
|
Constructor and Description |
---|
MiscellaneousCharge()
Constructs a new miscellaneous charge.
|
MiscellaneousCharge(java.lang.String uid, java.lang.String currency, java.math.BigDecimal amount, java.lang.String description)
Constructs a new miscellaneous charge.
|
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal | getAmount()
This method is a convenience method for retrieving the miscellaneous charge amount.
|
java.lang.String | getCurrency()
This method is a convenience method for retrieving the miscellaneous charge currency.
|
java.lang.String | getDescription()
This method is a convenience method for retrieving the miscellaneous charge description.
|
java.lang.String | getFormattedAmount()
This method is a convenience method for retrieving the formatted miscellaneous charge amount formatted using Globalization.formatCurrency(String, BigDecimal, boolean) This method returns the data stored under the PROP_FORMATTED_AMOUNT property.
|
java.lang.String | getProductCode()
This method is a convenience method for retrieving the product code.
|
java.lang.String | getPromotionCode()
This method is a convenience method for retrieving the miscellaneous charge promotion code.
|
java.lang.String | getUniqueIdentifier()
This method is a convenience method for retrieving the unique identifier of this miscellaneous charge.
|
void | setAmount(java.math.BigDecimal amount)
This is a convenience method for setting the miscellaneous charge amount.
|
void | setCurrency(java.lang.String currency)
This is a convenience method for setting the currency of the miscellaneous charge.
|
void | setDescription(java.lang.String description)
This is a convenience method for setting the description of the miscellaneous charge.
|
void | setProductCode(java.lang.String productCode)
This method is a convenience method for setting the product code.
|
void | setPromotionCode(java.lang.String promotionCode)
This is a convenience method for setting the promotion code of the miscellaneous charge.
|
void | setUniqueIdentifier(java.lang.String uid)
This is a convenience method for setting the unique identifier of the miscellaneous charge.
|
public static final java.lang.String INVALID_UID
public static final java.lang.String PROP_CURRENCY
The value is "currency".
The data stored under the "currency" property is a String that represents the miscellaneous charge's currency.
public static final java.lang.String PROP_AMOUNT
The value is "amount".
The data stored under the "amount" property is a BigDecimal that represents the miscellaneous charge's total amount.
public static final java.lang.String PROP_FORMATTED_AMOUNT
The value is "formattedAmount".
The data stored under the "formattedAmount" property is a String that represents the miscellaneous charge's total amount formatted based on the locale currency. The data stored in this property is used for display purpose.
public static final java.lang.String PROP_UID
The value is "uid".
The data stored under the "uid" property is a String that represents the miscellaneous charge's unique identifier.
public static final java.lang.String PROP_DESCRIPTION
The value is "description".
The data stored under the "description" property is a String that represents the miscellaneous charge's description.
public static final java.lang.String PROP_PROMOTION_CODE
The value is "promotionCode".
The data stored under the "promotionCode" property is a String that represents the miscellaneous charge's promotion Code.
public static final java.lang.String PROP_PRODUCT_CODE
The value is "productCode".
The data stored under the "productCode" property is a String that represents the product.
public MiscellaneousCharge()
public MiscellaneousCharge(java.lang.String uid, java.lang.String currency, java.math.BigDecimal amount, java.lang.String description)
public final java.math.BigDecimal getAmount()
public final java.lang.String getUniqueIdentifier()
public final java.lang.String getCurrency()
public final java.lang.String getFormattedAmount()
public final java.lang.String getDescription()
public final java.lang.String getPromotionCode()
public final java.lang.String getProductCode()
public void setAmount(java.math.BigDecimal amount)
public void setCurrency(java.lang.String currency)
public void setDescription(java.lang.String description)
public void setPromotionCode(java.lang.String promotionCode)
public void setProductCode(java.lang.String productCode)
public void setUniqueIdentifier(java.lang.String uid)