com.deltadna.android.sdk

Class Product<T extends Product<T>>

java.lang.Object

com.deltadna.android.sdk.Product<T>

All Implemented Interfaces:

JsonParams

public class Product<T extends Product<T>>
extends java.lang.Object
implements JsonParams

Constructs a product, to be used in conjunction with a Transaction.

Constructor Summary

Constructors

Constructor and Description
Product() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
T	addItem(java.lang.String name, java.lang.String type, int amount) Adds an item to the product.
T	addVirtualCurrency(java.lang.String name, java.lang.String type, long amount) Adds a virtual currency to the product.
static int	convertCurrency(DDNA ddna, java.lang.String code, float value) Converts a currency in a floating point format with a decimal point, such as '1.23' EUR, into an integer representation which can be used with setRealCurrency(String, int).
T	setRealCurrency(java.lang.String type, int amount) Set a real currency for the product.
org.json.JSONObject	toJson()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Product

public Product()

Creates a new instance.

Method Detail

toJson

public org.json.JSONObject toJson()

Specified by:

toJson in interface JsonParams

setRealCurrency

public T setRealCurrency(java.lang.String type,
                         int amount)

Set a real currency for the product.

Parameters:

type - type of the currency, using an ISO-4217 3 character currency code

amount - amount of the currency, using the minor currency unit

Returns:

this T instance

Throws:

java.lang.IllegalArgumentException - if the type is null or empty

See Also:

convertCurrency(DDNA, String, float)

addVirtualCurrency

public T addVirtualCurrency(java.lang.String name,
                            java.lang.String type,
                            long amount)

Adds a virtual currency to the product.

Parameters:

name - name of the currency

type - type of the currency, using an ISO-4217 3 character currency code

amount - amount of the currency, using the minor currency unit

Returns:

this T instance

Throws:

java.lang.IllegalArgumentException - if the name is null or empty

java.lang.IllegalArgumentException - if the type is null or empty

addItem

public T addItem(java.lang.String name,
                 java.lang.String type,
                 int amount)

Adds an item to the product.

Parameters:

name - name of the item

type - type of the item

amount - amount of the item

Returns:

this T instance

Throws:

java.lang.IllegalArgumentException - if the name is null or empty

java.lang.IllegalArgumentException - if the type is null or empty

convertCurrency

public static int convertCurrency(DDNA ddna,
                                  java.lang.String code,
                                  float value)

Converts a currency in a floating point format with a decimal point, such as '1.23' EUR, into an integer representation which can be used with setRealCurrency(String, int). This method will also work for currencies which don't use a minor currency unit, for example such as the Japanese Yen (JPY).

Parameters:

ddna - the SDK instance

code - the ISO 4217 currency code

value - the currency value to convert

Returns:

the converted integer value

Throws:

java.lang.IllegalArgumentException - if ddna is null

java.lang.IllegalArgumentException - if code is null or empty