CartLineItem Class

  • java.lang.Object
    • com.microsoft.store.partnercenter.models.carts.CartLineItem

public class CartLineItem

Represents a line item on a cart.

Constructor Summary

Constructor Description
CartLineItem()

Method Summary

Modifier and Type Method and Description
java.util.List<CartLineItem> getAddOnItems()

Gets a list of items that depend on this one, so they have to be purchased subsequently.

BillingCycleType getBillingCycle()

Gets the type of billing cycle for the selected catalog item.

java.lang.String getCatalogItemId()

Gets the catalog item identifier.

java.lang.String getCurrencyCode()

Gets the currency code.

CartError getError()

Gets the error associated to this cart line item.

java.lang.String getFriendlyName()

Gets the friendly name for the result contract (subscription).

int getId()

Gets the unique identifier of a cart line item.

java.lang.String getOrderGroup()

Gets the order group which indicates which items can be place in a single order.

java.util.Collection<KeyValuePair<ParticipantType,java.lang.String>> getParticipants()

Gets the collection of participants on this purchase.

java.util.Map<java.lang.String,java.lang.String> getProvisioningContext()

Gets the context that will be used for provisioning of the catalog item.

int getQuantity()

Gets the product quantity.

RenewsTo getRenewsTo()

Gets the renews to value.

java.lang.String getTermDuration()

Gets the term duration if applicable.

void setAddOnItems(List<CartLineItem> value)

Sets a list of items that depend on this one, so they have to be purchased subsequently.

void setBillingCycle(BillingCycleType value)

Sets the type of billing cycle for the selected catalog item.

void setCatalogItemId(String value)

Sets the catalog item identifier.

void setCurrencyCode(String value)

Sets the currency code.

void setError(CartError value)

Sets the error associated to this cart line item.

void setFriendlyName(String value)

Sets the friendly name for the result contract (subscription).

void setId(int value)

Sets the unique identifier of a cart line item.

void setOrderGroup(String value)

Sets the order group which indicates which items can be place in a single order.

void setParticipants(Collection<KeyValuePair<ParticipantType,String>> value)

Sets the collection of participants on this purchase.

void setProvisioningContext(Map<String,String> value)

Sets the context that will be used for provisioning of the catalog item.

void setQuantity(int value)

Sets the product quantity.

void setRenewsTo(RenewsTo value)

Sets the renews to value.

void setTermDuration(String value)

Sets the term duration if applicable.

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructor Details

CartLineItem

public CartLineItem()

Method Details

getAddOnItems

public List getAddOnItems()

Gets a list of items that depend on this one, so they have to be purchased subsequently.

Returns:

A list of items that depend on this one, so they have to be purchased subsequently.

getBillingCycle

public BillingCycleType getBillingCycle()

Gets the type of billing cycle for the selected catalog item.

Returns:

The type of billing cycle for the selected catalog item.

getCatalogItemId

public String getCatalogItemId()

Gets the catalog item identifier.

Returns:

The catalog item identifier.

getCurrencyCode

public String getCurrencyCode()

Gets the currency code.

Returns:

The currency code.

getError

public CartError getError()

Gets the error associated to this cart line item.

Returns:

The error associated to this cart line item.

getFriendlyName

public String getFriendlyName()

Gets the friendly name for the result contract (subscription).

Returns:

The friendly name for the result contract (subscription).

getId

public int getId()

Gets the unique identifier of a cart line item.

Returns:

The unique identifier of a cart line item.

getOrderGroup

public String getOrderGroup()

Gets the order group which indicates which items can be place in a single order.

Returns:

The order group which indicates which items can be place in a single order.

getParticipants

public Collection> getParticipants()

Gets the collection of participants on this purchase.

Returns:

The collection of participants on this purchase.

getProvisioningContext

public Map getProvisioningContext()

Gets the context that will be used for provisioning of the catalog item.

Returns:

The context that will be used for provisioning of the catalog item.

getQuantity

public int getQuantity()

Gets the product quantity.

Returns:

The product quantity.

getRenewsTo

public RenewsTo getRenewsTo()

Gets the renews to value.

Returns:

The renews to value.

getTermDuration

public String getTermDuration()

Gets the term duration if applicable.

Returns:

The term duration if applicable.

setAddOnItems

public void setAddOnItems(List value)

Sets a list of items that depend on this one, so they have to be purchased subsequently.

Parameters:

value - A list of items that depend on this one, so they have to be purchased subsequently.

setBillingCycle

public void setBillingCycle(BillingCycleType value)

Sets the type of billing cycle for the selected catalog item.

Parameters:

value - The type of billing cycle for the selected catalog item.

setCatalogItemId

public void setCatalogItemId(String value)

Sets the catalog item identifier.

Parameters:

value - The catalog item identifier.

setCurrencyCode

public void setCurrencyCode(String value)

Sets the currency code.

Parameters:

value - The currency code.

setError

public void setError(CartError value)

Sets the error associated to this cart line item.

Parameters:

value - The error associated to this cart line item.

setFriendlyName

public void setFriendlyName(String value)

Sets the friendly name for the result contract (subscription).

Parameters:

value - The friendly name for the result contract (subscription).

setId

public void setId(int value)

Sets the unique identifier of a cart line item.

Parameters:

value - The unique identifier of a cart line item.

setOrderGroup

public void setOrderGroup(String value)

Sets the order group which indicates which items can be place in a single order.

Parameters:

value - The order group which indicates which items can be place in a single order.

setParticipants

public void setParticipants(Collection> value)

Sets the collection of participants on this purchase.

Parameters:

value - The collection of participants on this purchase.

setProvisioningContext

public void setProvisioningContext(Map value)

Sets the context that will be used for provisioning of the catalog item.

Parameters:

value - The context that will be used for provisioning of the catalog item.

setQuantity

public void setQuantity(int value)

Sets the product quantity.

Parameters:

value - The product quantity.

setRenewsTo

public void setRenewsTo(RenewsTo value)

Sets the renews to value.

Parameters:

value - The renews to value.

setTermDuration

public void setTermDuration(String value)

Sets the term duration if applicable.

Parameters:

value - The term duration if applicable.

Applies to