com.konakart.app

Class CreateOrderOptions

java.lang.Object

com.konakart.app.CreateOrderOptions

All Implemented Interfaces:

CreateOrderOptionsIf

public class CreateOrderOptions
extends java.lang.Object
implements CreateOrderOptionsIf

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

Constructor Summary

Constructors

Constructor and Description
CreateOrderOptions() Constructor

Method Summary

Modifier and Type	Method and Description
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
java.lang.String	getCouponCode() The value of the coupon code to use when creating the order
java.lang.String	getCurrencyCode() The currency code of the currency to be used for the order.
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	getGiftCertCode() The value of the gift certificate code to use when creating the order
int[]	getInventoryUpdateExcludeProdTypes() Used to define product types that are excluded from inventory updates.
java.lang.String	getLocale() Locale of the customer
java.lang.String	getPaymentModuleCode() The code of the payment module to set for the order (e.g.
java.lang.String	getPaymentModuleSubCode() The sub code of the payment module to set for the order.
java.util.Calendar	getPriceDate() The date for which a price is requested.
java.lang.String	getShippingModuleCode() The code of the shipping module to set for the order (e.g.
java.lang.String	getShippingServiceCode() The service code of the shipping module to set for the order.
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	isGetImages() When creating the order we attach a product object to each order product.
boolean	isPopulateAvailablePaymentGateways() When set to true, the order is populated with an array of available payment gateways.
boolean	isPopulateAvailableShippingQuotes() When set to true the order is populated with an array of available shipping quotes.
boolean	isPopulateOrderTotals() When set to true, the order is populated with its order total modules.
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	setCouponCode(java.lang.String couponCode) The value of the coupon code to use when creating the order
void	setCurrencyCode(java.lang.String currencyCode) The currency code of the currency to be used for 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	setGetImages(boolean getImages) When creating the order we attach a product object to each order product.
void	setGiftCertCode(java.lang.String giftCertCode) The value of the gift certificate code to use when creating the order
void	setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes) Used to define product types that are excluded from inventory updates.
void	setLocale(java.lang.String locale) Locale of the customer
void	setPaymentModuleCode(java.lang.String paymentModuleCode) The code of the payment module to set for the order (e.g.
void	setPaymentModuleSubCode(java.lang.String paymentModuleSubCode) The sub code of the payment module to set for the order.
void	setPopulateAvailablePaymentGateways(boolean populateAvailablePaymentGateways) When set to true, the order is populated with an array of available payment gateways.
void	setPopulateAvailableShippingQuotes(boolean populateAvailableShippingQuotes) When set to true the order is populated with an array of available shipping quotes.
void	setPopulateOrderTotals(boolean populateOrderTotals) When set to true, the order is populated with its order total modules.
void	setPriceDate(java.util.Calendar priceDate) The date for which a price is requested.
void	setShippingModuleCode(java.lang.String shippingModuleCode) The code of the shipping module to set for the order (e.g.
void	setShippingServiceCode(java.lang.String shippingServiceCode) The service code of the shipping module to set for the order.
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

CreateOrderOptions

public CreateOrderOptions()

Constructor

Method Detail

isCopyBasketCustomFields

public boolean isCopyBasketCustomFields()

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

isCopyBasketCustomFields in interface CreateOrderOptionsIf

Returns:

Returns the copyBasketCustomFields.

setCopyBasketCustomFields

public void setCopyBasketCustomFields(boolean copyBasketCustomFields)

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

setCopyBasketCustomFields in interface CreateOrderOptionsIf

Parameters:

copyBasketCustomFields - The copyBasketCustomFields to set.

isUseDefaultCustomer

public boolean isUseDefaultCustomer()

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

isUseDefaultCustomer in interface CreateOrderOptionsIf

Returns:

Returns the useDefaultCustomer.

setUseDefaultCustomer

public void setUseDefaultCustomer(boolean useDefaultCustomer)

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

setUseDefaultCustomer in interface CreateOrderOptionsIf

Parameters:

useDefaultCustomer - The useDefaultCustomer to set.

getCatalogId

public java.lang.String getCatalogId()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

getCatalogId in interface CreateOrderOptionsIf

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setCatalogId in interface CreateOrderOptionsIf

Parameters:

catalogId - the catalogId to set

getPriceDate

public java.util.Calendar getPriceDate()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

getPriceDate in interface CreateOrderOptionsIf

Returns:

the priceDate

setPriceDate

public void setPriceDate(java.util.Calendar priceDate)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setPriceDate in interface CreateOrderOptionsIf

Parameters:

priceDate - the priceDate to set

isUseWishListShippingAddr

public boolean isUseWishListShippingAddr()

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

isUseWishListShippingAddr in interface CreateOrderOptionsIf

Returns:

the useWishListShippingAddr

setUseWishListShippingAddr

public void setUseWishListShippingAddr(boolean useWishListShippingAddr)

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

setUseWishListShippingAddr in interface CreateOrderOptionsIf

Parameters:

useWishListShippingAddr - the useWishListShippingAddr to set

isUseExternalPrice

public boolean isUseExternalPrice()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

isUseExternalPrice in interface CreateOrderOptionsIf

Returns:

the useExternalPrice

setUseExternalPrice

public void setUseExternalPrice(boolean useExternalPrice)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setUseExternalPrice in interface CreateOrderOptionsIf

Parameters:

useExternalPrice - the useExternalPrice to set

getLocale

public java.lang.String getLocale()

Locale of the customer

Specified by:

getLocale in interface CreateOrderOptionsIf

Returns:

the locale

setLocale

public void setLocale(java.lang.String locale)

Locale of the customer

Specified by:

setLocale in interface CreateOrderOptionsIf

Parameters:

locale - the locale to set

isUseExternalQuantity

public boolean isUseExternalQuantity()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

isUseExternalQuantity in interface CreateOrderOptionsIf

Returns:

the useExternalQuantity

setUseExternalQuantity

public void setUseExternalQuantity(boolean useExternalQuantity)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setUseExternalQuantity in interface CreateOrderOptionsIf

Parameters:

useExternalQuantity - the useExternalQuantity to set

getBillingAddrId

public int getBillingAddrId()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

getBillingAddrId in interface CreateOrderOptionsIf

Returns:

the billingAddrId

setBillingAddrId

public void setBillingAddrId(int billingAddrId)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setBillingAddrId in interface CreateOrderOptionsIf

Parameters:

billingAddrId - the billingAddrId to set

getCustomerAddrId

public int getCustomerAddrId()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

getCustomerAddrId in interface CreateOrderOptionsIf

Returns:

the customerAddrId

setCustomerAddrId

public void setCustomerAddrId(int customerAddrId)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setCustomerAddrId in interface CreateOrderOptionsIf

Parameters:

customerAddrId - the customerAddrId to set

getDeliveryAddrId

public int getDeliveryAddrId()

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

getDeliveryAddrId in interface CreateOrderOptionsIf

Returns:

the deliveryAddrId

setDeliveryAddrId

public void setDeliveryAddrId(int deliveryAddrId)

Description copied from interface: CreateOrderOptionsIf

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

Specified by:

setDeliveryAddrId in interface CreateOrderOptionsIf

Parameters:

deliveryAddrId - the deliveryAddrId to set

isCalcQuantityForBundles

public boolean isCalcQuantityForBundles()

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

isCalcQuantityForBundles in interface CreateOrderOptionsIf

Returns:

the calcQuantityForBundles

setCalcQuantityForBundles

public void setCalcQuantityForBundles(boolean calcQuantityForBundles)

Description copied from interface: CreateOrderOptionsIf

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.

Specified by:

setCalcQuantityForBundles in interface CreateOrderOptionsIf

Parameters:

calcQuantityForBundles - the calcQuantityForBundles to set

getCouponCode

public java.lang.String getCouponCode()

The value of the coupon code to use when creating the order

Specified by:

getCouponCode in interface CreateOrderOptionsIf

Returns:

the couponCode

setCouponCode

public void setCouponCode(java.lang.String couponCode)

The value of the coupon code to use when creating the order

Specified by:

setCouponCode in interface CreateOrderOptionsIf

Parameters:

couponCode - the couponCode to set

getGiftCertCode

public java.lang.String getGiftCertCode()

The value of the gift certificate code to use when creating the order

Specified by:

getGiftCertCode in interface CreateOrderOptionsIf

Returns:

the giftCertCode

setGiftCertCode

public void setGiftCertCode(java.lang.String giftCertCode)

The value of the gift certificate code to use when creating the order

Specified by:

setGiftCertCode in interface CreateOrderOptionsIf

Parameters:

giftCertCode - the giftCertCode to set

isPopulateAvailableShippingQuotes

public boolean isPopulateAvailableShippingQuotes()

When set to true the order is populated with an array of available shipping quotes. The default value is false. The selected shipping quote for the order is either the first in the list or if shippingModuleCode and shippingServiceCode are set, it attempts to find these codes in the list of available shipping quotes and if found it uses this quote as the selected shipping quote.

Specified by:

isPopulateAvailableShippingQuotes in interface CreateOrderOptionsIf

Returns:

the populateAvailableShippingQuotes

setPopulateAvailableShippingQuotes

public void setPopulateAvailableShippingQuotes(boolean populateAvailableShippingQuotes)

When set to true the order is populated with an array of available shipping quotes. The default value is false. The selected shipping quote for the order is either the first in the list or if shippingModuleCode and shippingServiceCode are set, it attempts to find these codes in the list of available shipping quotes and if found it uses this quote as the selected shipping quote.

Specified by:

setPopulateAvailableShippingQuotes in interface CreateOrderOptionsIf

Parameters:

populateAvailableShippingQuotes - the populateAvailableShippingQuotes to set

getShippingModuleCode

public java.lang.String getShippingModuleCode()

The code of the shipping module to set for the order (e.g. flat, free, ups). This is only used if populateAvailableShippingQuotes is set to true.

Specified by:

getShippingModuleCode in interface CreateOrderOptionsIf

Returns:

the shippingModuleCode

setShippingModuleCode

public void setShippingModuleCode(java.lang.String shippingModuleCode)

The code of the shipping module to set for the order (e.g. flat, free, ups). This is only used if populateAvailableShippingQuotes is set to true.

Specified by:

setShippingModuleCode in interface CreateOrderOptionsIf

Parameters:

shippingModuleCode - the shippingModuleCode to set

getShippingServiceCode

public java.lang.String getShippingServiceCode()

The service code of the shipping module to set for the order. A service code may be defined for shipping modules that return multiple quotes (e.g. overnight, 2-day etc.).This is only used if populateAvailableShippingQuotes is set to true.

Specified by:

getShippingServiceCode in interface CreateOrderOptionsIf

Returns:

the shippingServiceCode

setShippingServiceCode

public void setShippingServiceCode(java.lang.String shippingServiceCode)

The service code of the shipping module to set for the order. A service code may be defined for shipping modules that return multiple quotes (e.g. overnight, 2-day etc.).This is only used if populateAvailableShippingQuotes is set to true.

Specified by:

setShippingServiceCode in interface CreateOrderOptionsIf

Parameters:

shippingServiceCode - the shippingServiceCode to set

isPopulateAvailablePaymentGateways

public boolean isPopulateAvailablePaymentGateways()

When set to true, the order is populated with an array of available payment gateways. The default value is false. The selected payment module for the order is either the first in the list or if paymentModuleCode and paymentModuleSubCode are set, it attempts to find these codes in the list of available payment gateways and if found it uses this gateway as the selected payment gateway.

Specified by:

isPopulateAvailablePaymentGateways in interface CreateOrderOptionsIf

Returns:

the populateAvailablePaymentGateways

setPopulateAvailablePaymentGateways

public void setPopulateAvailablePaymentGateways(boolean populateAvailablePaymentGateways)

When set to true, the order is populated with an array of available payment gateways. The default value is false. The selected payment module for the order is either the first in the list or if paymentModuleCode and paymentModuleSubCode are set, it attempts to find these codes in the list of available payment gateways and if found it uses this gateway as the selected payment gateway.

Specified by:

setPopulateAvailablePaymentGateways in interface CreateOrderOptionsIf

Parameters:

populateAvailablePaymentGateways - the populateAvailablePaymentGateways to set

getPaymentModuleCode

public java.lang.String getPaymentModuleCode()

The code of the payment module to set for the order (e.g. cod, worldpay, paypal). This is only used if populateAvailablePaymentGateways is set to true.

Specified by:

getPaymentModuleCode in interface CreateOrderOptionsIf

Returns:

the paymentModuleCode

setPaymentModuleCode

public void setPaymentModuleCode(java.lang.String paymentModuleCode)

The code of the payment module to set for the order (e.g. cod, worldpay, paypal). This is only used if populateAvailablePaymentGateways is set to true.

Specified by:

setPaymentModuleCode in interface CreateOrderOptionsIf

Parameters:

paymentModuleCode - the paymentModuleCode to set

getPaymentModuleSubCode

public java.lang.String getPaymentModuleSubCode()

The sub code of the payment module to set for the order. This is only used if populateAvailablePaymentGateways is set to true. A subCode is used when a payment module supports multiple payment methods.

Specified by:

getPaymentModuleSubCode in interface CreateOrderOptionsIf

Returns:

the paymentModuleSubCode

setPaymentModuleSubCode

public void setPaymentModuleSubCode(java.lang.String paymentModuleSubCode)

The sub code of the payment module to set for the order. This is only used if populateAvailablePaymentGateways is set to true. A subCode is used when a payment module supports multiple payment methods.

Specified by:

setPaymentModuleSubCode in interface CreateOrderOptionsIf

Parameters:

paymentModuleSubCode - the paymentModuleSubCode to set

isPopulateOrderTotals

public boolean isPopulateOrderTotals()

When set to true, the order is populated with its order total modules.

Specified by:

isPopulateOrderTotals in interface CreateOrderOptionsIf

Returns:

the populateOrderTotals

setPopulateOrderTotals

public void setPopulateOrderTotals(boolean populateOrderTotals)

When set to true, the order is populated with its order total modules.

Specified by:

setPopulateOrderTotals in interface CreateOrderOptionsIf

Parameters:

populateOrderTotals - the populateOrderTotals to set

isGetImages

public boolean isGetImages()

When creating the order we attach a product object to each order product. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

isGetImages in interface CreateOrderOptionsIf

Returns:

the getImages

setGetImages

public void setGetImages(boolean getImages)

When creating the order we attach a product object to each order product. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

setGetImages in interface CreateOrderOptionsIf

Parameters:

getImages - the getImages to set

getInventoryUpdateExcludeProdTypes

public int[] getInventoryUpdateExcludeProdTypes()

Used to define product types that are excluded from inventory updates. Used in the updateInventoryWithOptions() API call. Valid product types are:

• com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT
• com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD
• com.konakart.bl.ProductMgr.FREE_SHIPPING
• com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE

Specified by:

getInventoryUpdateExcludeProdTypes in interface CreateOrderOptionsIf

Returns:

the inventoryUpdateExcludeProdTypes

setInventoryUpdateExcludeProdTypes

public void setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes)

Used to define product types that are excluded from inventory updates. Used in the updateInventoryWithOptions() API call. Valid product types are:

• com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT
• com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD
• com.konakart.bl.ProductMgr.FREE_SHIPPING
• com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE
• com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE

Specified by:

setInventoryUpdateExcludeProdTypes in interface CreateOrderOptionsIf

Parameters:

inventoryUpdateExcludeProdTypes - the inventoryUpdateExcludeProdTypes to set

getCurrencyCode

public java.lang.String getCurrencyCode()

The currency code of the currency to be used for the order. If null then the store default currency is used

Specified by:

getCurrencyCode in interface CreateOrderOptionsIf

Returns:

the currencyCode

setCurrencyCode

public void setCurrencyCode(java.lang.String currencyCode)

The currency code of the currency to be used for the order. If null then the store default currency is used

Specified by:

setCurrencyCode in interface CreateOrderOptionsIf

Parameters:

currencyCode - the currencyCode to set