jNewer Version Available
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
commercestorepricing.TransactionalPricingResponseItem
Represents an item with in the TransactionalPricingResponse containing product pricing information
Constructors
global TransactionalPricingResponseItem(String lineId, String productId, String unitPricePriceBookEntryId, Decimal listPrice, Decimal unitPrice, Decimal totalListPrice, Decimal totalLineAmount, Decimal totalAdjustmentAmount, Decimal unitAdjustmentAmount, Decimal totalPrice, Decimal quantity, String currencyIsoCode)
Constructs a PricingResponseItem with product pricing information by delegating call to internal java class
global TransactionalPricingResponseItem(String lineId, String productId, String productSellingModelId, String prorationPolicyId, Integer subscriptionTerm, Datetime startDate, Datetime endDate, String unitPricePriceBookEntryId, Decimal listPrice, Decimal unitPrice, Decimal totalListPrice, Decimal totalLineAmount, Decimal totalAdjustmentAmount, Decimal unitAdjustmentAmount, Decimal totalPrice, Decimal quantity, String billingFrequency, String currencyIsoCode)
Constructs TransactionalPricingResponse using product information by delegating the call to internal java class
Throws
| Exception | Description |
|---|---|
NoAccessException | If org does not have commerce subscription plus enabled |
Methods
global getLineId()
Returns the product line id
Returns
| Type | Description |
|---|---|
| String | Product Line Id |
global setLineId(String lineId)
Sets the product line id for the response item
Parameters
| Param | Description |
|---|---|
lineId | Product Line Id |
global getProductId()
Returns the productId
Returns
| Type | Description |
|---|---|
| String | Product Id |
global setProductId(String productId)
Set productId for the response item param productId Product Id
global getProductSellingModelId()
Returns the ProductSellingModelId
Returns
| Type | Description |
|---|---|
| String | Product Selling Model Id |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the organization does not have Commerce Subscription Plus enabled. |
global setProductSellingModelId(String productSellingModelId)
Sets ProductSellingModelId for this pricing response item
Parameters
| Param | Description |
|---|---|
productSellingModelId | Product Selling Model Id |
global getProrationPolicyId()
Retrieves the ProrationPolicyId
Returns
| Type | Description |
|---|---|
| String | ProrationPolicyId |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the organization does not have Commerce Subscription Plus enabled. |
global setProrationPolicyId(String prorationPolicyId)
Sets ProrationPolicyId for this pricing response item
Parameters
| Param | Description |
|---|---|
prorationPolicyId | ProrationPolicyId |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the organization does not have Commerce Subscription Plus enabled. |
global getSubscriptionTerm()
Retrieves subscription term of the product
Returns
| Type | Description |
|---|---|
| Integer | Subscription term |
global setSubscriptionTerm(Integer subscriptionTerm)
Sets Subscription term
Parameters
| Param | Description |
|---|---|
subscriptionTerm | Subscription term of the product |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the organization does not have Commerce Subscription Plus enabled. |
global getStartDate()
Retrieves the start date of the subscription.
Returns
| Type | Description |
|---|---|
| Datetime | The start date of the subscription. |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the commerce subscription plus feature is not enabled for the organization. |
global setStartDate(Datetime startDate)
Sets the start date of the subscription.
Parameters
| Param | Description |
|---|---|
startDate | The start date of the subscription. |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the commerce subscription plus feature is not enabled for the organization. |
global getEndDate()
Retrieves the end date of the subscription.
Returns
| Type | Description |
|---|---|
| Datetime | The end date of the subscription. |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the commerce subscription plus feature is not enabled for the organization. |
global setEndDate(Datetime endDate)
Sets the end date of the subscription.
Parameters
| Param | Description |
|---|---|
endDate | The end date of the subscription. |
Throws
| Exception | Description |
|---|---|
NoAccessException | If the commerce subscription plus feature is not enabled for the organization. |
global getUnitPricePriceBookEntryId()
Retrieves the Id of PricebookEntry associated to unit price of the product
Returns
| Type | Description |
|---|---|
| String | PricebookEntry Id |
global setUnitPricePriceBookEntryId(String unitPricePriceBookEntryId)
Sets the Id of PricebookEntry associated to unit price of the product
Parameters
| Param | Description |
|---|---|
unitPricePriceBookEntryId | PricebookEntry Id |
global getListPrice()
Returns the standard price the product
Returns
| Type | Description |
|---|---|
| Decimal | Standard price of the product |
global setListPrice(Decimal listPrice)
Set the listPrice of the product
Parameters
| Param | Description |
|---|---|
listPrice | Standard price of the product |
global getUnitPrice()
Returns the Unit price the product
Returns
| Type | Description |
|---|---|
| Decimal | Unit Price of the product |
global setUnitPrice(Decimal unitPrice)
Sets the Unit price the product
Parameters
| Param | Description |
|---|---|
unitPrice | Unit Price of the product |
global getTotalListPrice()
Returns the list price of the item
Returns
| Type | Description |
|---|---|
| Decimal | List price |
global setTotalListPrice(Decimal totalListPrice)
Sets the list price of the item
Parameters
| Param | Description |
|---|---|
totalListPrice | List price |
global getTotalLineAmount()
Returns total amount including adjustment amount
Returns
| Type | Description |
|---|---|
| Decimal | Total amount including adjustment amount |
global setTotalLineAmount(Decimal totalLineAmount)
Sets total line amount
Parameters
| Param | Description |
|---|---|
totalLineAmount | Total amount including adjustment amount |
global getTotalAdjustmentAmount()
Returns total adjustment amount for the line item
Returns
| Type | Description |
|---|---|
| Decimal | Total adjustment amount |
global setTotalAdjustmentAmount(Decimal totalAdjustmentAmount)
Sets total adjustment amount for the line item
Parameters
| Param | Description |
|---|---|
totalAdjustmentAmount | Total adjustment amount |
global getUnitAdjustmentAmount()
Returns Per unit adjustment amount which is the adjustment amount divided by qty rounded by currency
Returns
| Type | Description |
|---|---|
| Decimal | Per unit adjustment amount |
global setUnitAdjustmentAmount(Decimal unitAdjustmentAmount)
Sets Per unit adjustment amount which is the adjustment amount divided by qty rounded by currency
Parameters
| Param | Description |
|---|---|
unitAdjustmentAmount | Per unit adjustment amount |
global getTotalPrice()
Returns price of the line item multiplied with qty rounded by currency
Returns
| Type | Description |
|---|---|
| Decimal | Total Price of the line item |
global setTotalPrice(Decimal totalPrice)
Sets price of the line item multiplied with qty rounded by currency
Parameters
| Param | Description |
|---|---|
totalPrice | Total Price of the line item |
global getQuantity()
Returns quantity of the line item
Returns
| Type | Description |
|---|---|
| Decimal | Quantity of the line item |
global setQuantity(Decimal quantity)
Sets quantity of the line item
Parameters
| Param | Description |
|---|---|
quantity | Quantity of the line item |
global getBillingFrequency()
Returns Billing frequency
Returns
| Type | Description |
|---|---|
| String | Billing frequency |
global setBillingFrequency(String billingFrequency)
Sets Billing frequency
Parameters
| Param | Description |
|---|---|
billingFrequency | Billing frequency |
global getCurrencyIsoCode()
Returns Currency ISO Code of the line item
Returns
| Type | Description |
|---|---|
| String | Currency ISO Code |
global setCurrencyIsoCode(String currencyIsoCode)
Sets Currency ISO Code
Parameters
| Param | Description |
|---|---|
currencyIsoCode | Currency ISO Code |
global isSuccess()
Returns true if there are no errors in fetching the prices
Returns
| Type | Description |
|---|---|
| Boolean | True if there are no errors in fetching the prices, false otherwise |
global getErrorMessage()
Retrieves error message in case of errors when fetching the pricing information
Returns
| Type | Description |
|---|---|
| String | Error message |
global getLocalizedErrorMessage()
Retrieves localized error message in case of errors when fetching the pricing information
Returns
| Type | Description |
|---|---|
| String | Localized error message |
global getErrorCode()
Returns error code in case of errors in fetching the pricing information
Returns
| Type | Description |
|---|---|
| String | Error code |
global setError(String errorMessage, String localizedErrorMessage)
Set error message and localized error message
Parameters
| Param | Description |
|---|---|
errorMessage | Error message |
localizedErrorMessage | Localized error message |
global equals(Object obj)
Compares the argument with the underlying TransactionalPricingResponseItem object and returns true if they are equal
global hashCode()
Returns hash code for TransactionalPricingResponseItem object
j