PricingItem (TurnOnline.biz Ecosystem Administration 0.35 API)

java.lang.Object
- biz.turnonline.ecosystem.widget.shared.rest.billing.PricingItem

All Implemented Interfaces:: org.ctoolkit.gwt.client.facade.RelevantNullChecker

public final class PricingItem
extends Object
implements org.ctoolkit.gwt.client.facade.RelevantNullChecker

Constructor Summary

Constructors
Constructor and Description

PricingItem()

Constructors
Constructor and Description
`PricingItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allNull()`
`Double`	`getAmount()` The requested amount (quantity) of this item to be invoiced.
`Boolean`	`getCheckedIn()` The boolean indication whether this pricing item to include in to final price calculation or not.
`String`	`getCurrency()` The currency alphabetic code based on the ISO 4217.
`Boolean`	`getDiscountApplied()` The boolean indication whether this pricing item has already successfully applied for discounted price.
`String`	`getDiscountCode()` The discount code provided by the client in order to apply for price discount.
`Boolean`	`getDiscountCodeDefined()` The boolean indication whether associated product has defined a discount code.
`Boolean`	`getDiscountDefined()` The boolean indication whether associated product has defined a discount.
`Double`	`getFinalPrice()` The final price including VAT as a result of the calculation of the item price excluding VAT (VAT base), selected VAT and amount.
`Double`	`getFinalPriceExclVat()` The final price excluding VAT as the result of the calculation of the item price (excluding VAT) and amount.
`Double`	`getFinalValueAddedTax()` The VAT value, associated with the final VAT rate.
`String`	`getFinalVat()` The context sensitive (customer country etc) VAT code, taken from the VAT rate code book.
`Double`	`getFinalVatAmount()` The final amount of VAT as a result of the calculation of this item and its amount including target rounding mode.
`Double`	`getFinalVatBase()` The final VAT base as the result of the calculation of the item price excluding VAT and amount including rounding based on the rounding mode value.
`Long`	`getId()` The pricing item identification.
`String`	`getInline()` The inline item placed as a line at invoice, solely assembled by the service.
`String`	`getItemName()` The product name, a very short summary that will be used at invoice.
`List<PricingItem>`	`getItems()` The pricing items tree.
`String`	`getItemType()` The one of the supported item type.
`String`	`getItemUrl()` The product page URL once associated product has been published.
`ProductMetaFields`	`getMetaFields()` The product specific metadata fields configuration.
`Integer`	`getOrder()` The order number of the item within list if defined.
`String`	`getParentKey()` The unique identification either of the parent pricing item or parent Order (Invoice etc).
`Double`	`getPriceExclVat()` The product price for a single unit (meaning amount 1.0 as a quantity).
`PricingProduct`	`getProduct()` The matching product from the product catalog (solely identified by ID).
`String`	`getSnippet()` The product short description, a brief overview (not appearing at invoice).
`Map<String,Object>`	`getSubsidiary()` An optional subsidiary properties with single level (flat) structure - Map of values.
`String`	`getThumbnailUrl()` The thumbnail URL of the associated product picture once product has been published.
`String`	`getUnit()` The code from the billing unit codebook - unit of measure at invoice.
`Double`	`getValueAddedTax()` The current numeric representation of the value added tax (VAT) codebook item.
`String`	`getVat()` The VAT rate codebook value to be applied to calculate the final price of the product for domestic (seller) to domestic customer sale.
`PricingItem`	`setAmount(Double amount)`
`PricingItem`	`setCheckedIn(Boolean checkedIn)`
`PricingItem`	`setCurrency(String currency)`
`PricingItem`	`setDiscountApplied(Boolean discountApplied)`
`PricingItem`	`setDiscountCode(String discountCode)`
`PricingItem`	`setDiscountCodeDefined(Boolean discountCodeDefined)`
`PricingItem`	`setDiscountDefined(Boolean discountDefined)`
`PricingItem`	`setFinalPrice(Double finalPrice)`
`PricingItem`	`setFinalPriceExclVat(Double finalPriceExclVat)`
`PricingItem`	`setFinalValueAddedTax(Double finalValueAddedTax)`
`PricingItem`	`setFinalVat(String finalVat)`
`PricingItem`	`setFinalVatAmount(Double finalVatAmount)`
`PricingItem`	`setFinalVatBase(Double finalVatBase)`
`PricingItem`	`setId(Long id)`
`PricingItem`	`setInline(String inline)`
`PricingItem`	`setItemName(String itemName)`
`PricingItem`	`setItems(List<PricingItem> items)`
`PricingItem`	`setItemType(String itemType)`
`PricingItem`	`setItemUrl(String itemUrl)`
`PricingItem`	`setMetaFields(ProductMetaFields metaFields)`
`PricingItem`	`setOrder(Integer order)`
`PricingItem`	`setParentKey(String parentKey)`
`PricingItem`	`setPriceExclVat(Double priceExclVat)`
`PricingItem`	`setProduct(PricingProduct product)`
`PricingItem`	`setSnippet(String snippet)`
`PricingItem`	`setSubsidiary(Map<String,Object> subsidiary)`
`PricingItem`	`setThumbnailUrl(String thumbnailUrl)`
`PricingItem`	`setUnit(String unit)`
`PricingItem`	`setValueAddedTax(Double valueAddedTax)`
`PricingItem`	`setVat(String vat)`

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

Methods inherited from interface org.ctoolkit.gwt.client.facade.RelevantNullChecker
allNull, setIfNotAllNull

- Constructor Detail
  - PricingItem
```
public PricingItem()
```
- Method Detail
  - getAmount
```
public Double getAmount()
```
    The requested amount (quantity) of this item to be invoiced. For non leaf items only the integer of amount is being taken into account as it reflects number of child items. Higher precision is suitable only for leaf items.
  - setAmount
```
public PricingItem setAmount(Double amount)
```
  - getCheckedIn
```
public Boolean getCheckedIn()
```
    The boolean indication whether this pricing item to include in to final price calculation or not.
  - setCheckedIn
```
public PricingItem setCheckedIn(Boolean checkedIn)
```
  - getCurrency
```
public String getCurrency()
```
    The currency alphabetic code based on the ISO 4217. If not set, the account's default currency will be set.
  - setCurrency
```
public PricingItem setCurrency(String currency)
```
  - getDiscountApplied
```
public Boolean getDiscountApplied()
```
    The boolean indication whether this pricing item has already successfully applied for discounted price.
  - setDiscountApplied
```
public PricingItem setDiscountApplied(Boolean discountApplied)
```
  - getDiscountCode
```
public String getDiscountCode()
```
    The discount code provided by the client in order to apply for price discount. If discount has been defined and there is a match, the property discountApplied will return true.
  - setDiscountCode
```
public PricingItem setDiscountCode(String discountCode)
```
  - getDiscountCodeDefined
```
public Boolean getDiscountCodeDefined()
```
    The boolean indication whether associated product has defined a discount code.
  - setDiscountCodeDefined
```
public PricingItem setDiscountCodeDefined(Boolean discountCodeDefined)
```
  - getDiscountDefined
```
public Boolean getDiscountDefined()
```
    The boolean indication whether associated product has defined a discount.
  - setDiscountDefined
```
public PricingItem setDiscountDefined(Boolean discountDefined)
```
  - getFinalPrice
```
public Double getFinalPrice()
```
    The final price including VAT as a result of the calculation of the item price excluding VAT (VAT base), selected VAT and amount.
  - setFinalPrice
```
public PricingItem setFinalPrice(Double finalPrice)
```
  - getFinalPriceExclVat
```
public Double getFinalPriceExclVat()
```
    The final price excluding VAT as the result of the calculation of the item price (excluding VAT) and amount.
  - setFinalPriceExclVat
```
public PricingItem setFinalPriceExclVat(Double finalPriceExclVat)
```
  - getFinalValueAddedTax
```
public Double getFinalValueAddedTax()
```
    The VAT value, associated with the final VAT rate.
  - setFinalValueAddedTax
```
public PricingItem setFinalValueAddedTax(Double finalValueAddedTax)
```
  - getFinalVat
```
public String getFinalVat()
```
    The context sensitive (customer country etc) VAT code, taken from the VAT rate code book. The final VAT to be used for final price calculation.
  - setFinalVat
```
public PricingItem setFinalVat(String finalVat)
```
  - getFinalVatAmount
```
public Double getFinalVatAmount()
```
    The final amount of VAT as a result of the calculation of this item and its amount including target rounding mode.
  - setFinalVatAmount
```
public PricingItem setFinalVatAmount(Double finalVatAmount)
```
  - getFinalVatBase
```
public Double getFinalVatBase()
```
    The final VAT base as the result of the calculation of the item price excluding VAT and amount including rounding based on the rounding mode value.
  - setFinalVatBase
```
public PricingItem setFinalVatBase(Double finalVatBase)
```
  - getId
```
public Long getId()
```
    The pricing item identification. Unique only with combination of the parent key. The pricing resource might be a calculated in memory, thus no corresponding ID will be provided in this case.
  - setId
```
public PricingItem setId(Long id)
```
  - getInline
```
public String getInline()
```
    The inline item placed as a line at invoice, solely assembled by the service. Optionally, the content is language (Accept-Language) sensitive, but not for price. Will be present only for relevant 'itemType' (OrderItem , BillingItem).
  - setInline
```
public PricingItem setInline(String inline)
```
  - getItemName
```
public String getItemName()
```
    The product name, a very short summary that will be used at invoice. By default taken from the associated product if any. If provided by the client, it will take precedence. However, specific behaviour might be different based on the concrete type of 'itemType' property.
  - setItemName
```
public PricingItem setItemName(String itemName)
```
  - getItemType
```
public String getItemType()
```
    The one of the supported item type. The type has an impact how item will be handled and might have a various configuration and properties (by subsidiary). The root pricing item of the pricing tree structure must be one of the type: Standard, OrderItem, or BillingItem. Otherwise validation error will be returned as a bad request.
  - setItemType
```
public PricingItem setItemType(String itemType)
```
  - getItemUrl
```
public String getItemUrl()
```
    The product page URL once associated product has been published.
  - setItemUrl
```
public PricingItem setItemUrl(String itemUrl)
```
  - getItems
```
public List<PricingItem> getItems()
```
    The pricing items tree. A non empty list defines a price of this item by its children as a sum of all its items. The price is calculated recursively.
  - setItems
```
public PricingItem setItems(List<PricingItem> items)
```
  - getMetaFields
```
public ProductMetaFields getMetaFields()
```
    The product specific metadata fields configuration. It's read only. Values are taken from the associated product if any. Product is the master, if you need different values, change those values at product level.
  - setMetaFields
```
public PricingItem setMetaFields(ProductMetaFields metaFields)
```
  - getOrder
```
public Integer getOrder()
```
    The order number of the item within list if defined. Managed by the client only.
  - setOrder
```
public PricingItem setOrder(Integer order)
```
  - getParentKey
```
public String getParentKey()
```
    The unique identification either of the parent pricing item or parent Order (Invoice etc). Pricing item resource might be imbedded item of another pricing item infinitely. The pricing resource might be a calculated in memory, thus no corresponding ID will be provided in this case.
  - setParentKey
```
public PricingItem setParentKey(String parentKey)
```
  - getPriceExclVat
```
public Double getPriceExclVat()
```
    The product price for a single unit (meaning amount 1.0 as a quantity). The price is excluding VAT in case company is VAT payer, otherwise price is final.
  - setPriceExclVat
```
public PricingItem setPriceExclVat(Double priceExclVat)
```
  - getProduct
```
public PricingProduct getProduct()
```
    The matching product from the product catalog (solely identified by ID). If found, product's properties will be used to populate this pricing item. If not found or missing, the provided pricing item properties will be processed as a non catalog product. Note, for this 'product' property only subset of the product's properties will be placed here (at least ID).
  - setProduct
```
public PricingItem setProduct(PricingProduct product)
```
  - getSnippet
```
public String getSnippet()
```
    The product short description, a brief overview (not appearing at invoice). The plain text only. Values taken from the associated product if any.
  - setSnippet
```
public PricingItem setSnippet(String snippet)
```
  - getSubsidiary
```
public Map<String,Object> getSubsidiary()
```
    An optional subsidiary properties with single level (flat) structure - Map of values. Initial values taken from the associated product if any. Client is free to change it and manage it.
  - setSubsidiary
```
public PricingItem setSubsidiary(Map<String,Object> subsidiary)
```
  - getThumbnailUrl
```
public String getThumbnailUrl()
```
    The thumbnail URL of the associated product picture once product has been published. Served from the content delivery network (CDN).
  - setThumbnailUrl
```
public PricingItem setThumbnailUrl(String thumbnailUrl)
```
  - getUnit
```
public String getUnit()
```
    The code from the billing unit codebook - unit of measure at invoice.
  - setUnit
```
public PricingItem setUnit(String unit)
```
  - getValueAddedTax
```
public Double getValueAddedTax()
```
    The current numeric representation of the value added tax (VAT) codebook item.
  - setValueAddedTax
```
public PricingItem setValueAddedTax(Double valueAddedTax)
```
  - getVat
```
public String getVat()
```
    The VAT rate codebook value to be applied to calculate the final price of the product for domestic (seller) to domestic customer sale.
  - setVat
```
public PricingItem setVat(String vat)
```
  - allNull
```
public boolean allNull()
```
    Specified by:
    
    allNull in interface org.ctoolkit.gwt.client.facade.RelevantNullChecker

Class PricingItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.ctoolkit.gwt.client.facade.RelevantNullChecker

Constructor Detail

PricingItem

Method Detail

getAmount

setAmount

getCheckedIn

setCheckedIn

getCurrency

setCurrency

getDiscountApplied

setDiscountApplied

getDiscountCode

setDiscountCode

getDiscountCodeDefined

setDiscountCodeDefined

getDiscountDefined

setDiscountDefined

getFinalPrice

setFinalPrice

getFinalPriceExclVat

setFinalPriceExclVat

getFinalValueAddedTax

setFinalValueAddedTax

getFinalVat

setFinalVat

getFinalVatAmount

setFinalVatAmount

getFinalVatBase

setFinalVatBase

getId

setId

getInline

setInline

getItemName

setItemName

getItemType

setItemType

getItemUrl

setItemUrl

getItems

setItems

getMetaFields

setMetaFields

getOrder

setOrder

getParentKey

setParentKey

getPriceExclVat

setPriceExclVat

getProduct

setProduct

getSnippet

setSnippet

getSubsidiary

setSubsidiary

getThumbnailUrl

setThumbnailUrl

getUnit

setUnit

getValueAddedTax

setValueAddedTax

getVat

setVat

allNull