com.konakart.json.app
Class J_CreateOrderOptions

java.lang.Object
  com.konakart.json.app.J_CreateOrderOptions

All Implemented Interfaces:

java.io.Serializable

public class J_CreateOrderOptions
extends java.lang.Object
implements java.io.Serializable

An object used to contain options used when creating an order from an array of basket items.

See Also:

Serialized Form

Constructor Summary

J_CreateOrderOptions()

Method Summary

int	getBillingAddrId() Id of billing address to use when creating the order.
java.lang.String	getCatalogId() The id of the catalog which contains dynamic product information such as the price and quantity
int	getCustomerAddrId() Id of customer address to use when creating the order.
int	getDeliveryAddrId() Id of delivery address to use when creating the order.
java.lang.String	getLocale() Locale of the customer
java.util.Calendar	getPriceDate() The date for which a price is requested.
boolean	isCalcQuantityForBundles() When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.
boolean	isCopyBasketCustomFields() When this boolean is set, all the custom fields of a basket item are automatically copied to the custom fields of the OrderProduct object in the order.
boolean	isUseDefaultCustomer() This boolean is set so that an order can be created before a customer has logged in to the application.
boolean	isUseExternalPrice() If true we attempt to fetch the prices from the external table
boolean	isUseExternalQuantity() If true we attempt to fetch the quantities from the external table
boolean	isUseWishListShippingAddr() If any one of the basket items, has a valid wish list id, then we use the address of the wish list as the shipping address.
void	setBillingAddrId(int _billingAddrId) Id of billing address to use when creating the order.
void	setCalcQuantityForBundles(boolean _calcQuantityForBundles) When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.
void	setCatalogId(java.lang.String _catalogId) The id of the catalog which contains dynamic product information such as the price and quantity
void	setCopyBasketCustomFields(boolean _copyBasketCustomFields) When this boolean is set, all the custom fields of a basket item are automatically copied to the custom fields of the OrderProduct object in the order.
void	setCustomerAddrId(int _customerAddrId) Id of customer address to use when creating the order.
void	setDeliveryAddrId(int _deliveryAddrId) Id of delivery address to use when creating the order.
void	setLocale(java.lang.String _locale) Locale of the customer
void	setPriceDate(java.util.Calendar _priceDate) The date for which a price is requested.
void	setUseDefaultCustomer(boolean _useDefaultCustomer) This boolean is set so that an order can be created before a customer has logged in to the application.
void	setUseExternalPrice(boolean _useExternalPrice) If true we attempt to fetch the prices from the external table
void	setUseExternalQuantity(boolean _useExternalQuantity) If true we attempt to fetch the quantities from the external table
void	setUseWishListShippingAddr(boolean _useWishListShippingAddr) If any one of the basket items, has a valid wish list id, then we use the address of the wish list as the shipping address.

Methods inherited from class java.lang.Object

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

Constructor Detail

J_CreateOrderOptions

public J_CreateOrderOptions()

Method Detail

isCopyBasketCustomFields

public boolean isCopyBasketCustomFields()

When this boolean is set, all the custom fields of a basket item are automatically copied to the custom fields of the OrderProduct object in the order.

Returns:

Returns the copyBasketCustomFields.

setCopyBasketCustomFields

public void setCopyBasketCustomFields(boolean _copyBasketCustomFields)

When this boolean is set, all the custom fields of a basket item are automatically copied to the custom fields of the OrderProduct object in the order.

Parameters:

_copyBasketCustomFields - The copyBasketCustomFields to set.

isUseDefaultCustomer

public boolean isUseDefaultCustomer()

This boolean is set so that an order can be created before a customer has logged in to the application. We may want to do this to calculate the order totals so that they can be displayed in the edit cart screen to give additional information to a customer such as shipping charges, discounts etc. Since we don't have the details of the customer, the address of a "default customer" is used. The default customer can be configured in the Admin App. When this boolean is set, the session parameter can be set to null.

Returns:

Returns the useDefaultCustomer.

setUseDefaultCustomer

public void setUseDefaultCustomer(boolean _useDefaultCustomer)

This boolean is set so that an order can be created before a customer has logged in to the application. We may want to do this to calculate the order totals so that they can be displayed in the edit cart screen to give additional information to a customer such as shipping charges, discounts etc. Since we don't have the details of the customer, the address of a "default customer" is used. The default customer can be configured in the Admin App. When this boolean is set, the session parameter can be set to null.

Parameters:

_useDefaultCustomer - The useDefaultCustomer to set.

getCatalogId

public java.lang.String getCatalogId()

The id of the catalog which contains dynamic product information such as the price and quantity

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String _catalogId)

The id of the catalog which contains dynamic product information such as the price and quantity

Parameters:

_catalogId - the catalogId to set

getPriceDate

public java.util.Calendar getPriceDate()

The date for which a price is requested. It could be out in the future.

Returns:

the priceDate

setPriceDate

public void setPriceDate(java.util.Calendar _priceDate)

The date for which a price is requested. It could be out in the future.

Parameters:

_priceDate - the priceDate to set

isUseWishListShippingAddr

public boolean isUseWishListShippingAddr()

If any one of the basket items, has a valid wish list id, then we use the address of the wish list as the shipping address.

Returns:

the useWishListShippingAddr

setUseWishListShippingAddr

public void setUseWishListShippingAddr(boolean _useWishListShippingAddr)

If any one of the basket items, has a valid wish list id, then we use the address of the wish list as the shipping address.

Parameters:

_useWishListShippingAddr - the useWishListShippingAddr to set

isUseExternalPrice

public boolean isUseExternalPrice()

If true we attempt to fetch the prices from the external table

Returns:

the useExternalPrice

setUseExternalPrice

public void setUseExternalPrice(boolean _useExternalPrice)

If true we attempt to fetch the prices from the external table

Parameters:

_useExternalPrice - the useExternalPrice to set

getLocale

public java.lang.String getLocale()

Locale of the customer

Returns:

the locale

setLocale

public void setLocale(java.lang.String _locale)

Locale of the customer

Parameters:

_locale - the locale to set

isUseExternalQuantity

public boolean isUseExternalQuantity()

If true we attempt to fetch the quantities from the external table

Returns:

the useExternalQuantity

setUseExternalQuantity

public void setUseExternalQuantity(boolean _useExternalQuantity)

If true we attempt to fetch the quantities from the external table

Parameters:

_useExternalQuantity - the useExternalQuantity to set

getBillingAddrId

public int getBillingAddrId()

Id of billing address to use when creating the order. Overrides any other option that may conflict with this.

Returns:

the billingAddrId

setBillingAddrId

public void setBillingAddrId(int _billingAddrId)

Id of billing address to use when creating the order. Overrides any other option that may conflict with this.

Parameters:

_billingAddrId - the billingAddrId to set

getCustomerAddrId

public int getCustomerAddrId()

Id of customer address to use when creating the order. Overrides any other option that may conflict with this.

Returns:

the customerAddrId

setCustomerAddrId

public void setCustomerAddrId(int _customerAddrId)

Id of customer address to use when creating the order. Overrides any other option that may conflict with this.

Parameters:

_customerAddrId - the customerAddrId to set

getDeliveryAddrId

public int getDeliveryAddrId()

Id of delivery address to use when creating the order. Overrides any other option that may conflict with this.

Returns:

the deliveryAddrId

setDeliveryAddrId

public void setDeliveryAddrId(int _deliveryAddrId)

Id of delivery address to use when creating the order. Overrides any other option that may conflict with this.

Parameters:

_deliveryAddrId - the deliveryAddrId to set

isCalcQuantityForBundles

public boolean isCalcQuantityForBundles()

When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle. If set to false, when updating the inventory the quantities of the bundled products will not be updated.

Returns:

the calcQuantityForBundles

setCalcQuantityForBundles

public void setCalcQuantityForBundles(boolean _calcQuantityForBundles)

When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle. If set to false, when updating the inventory the quantities of the bundled products will not be updated.

Parameters:

_calcQuantityForBundles - the calcQuantityForBundles to set