com.konakart.appif
Interface CreateOrderOptionsIf

All Known Implementing Classes:

CreateOrderOptions

public interface CreateOrderOptionsIf

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

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	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	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.

Method Detail

isCopyBasketCustomFields

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

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

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

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

java.lang.String getCatalogId()

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

Returns:

the catalogId

setCatalogId

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

java.util.Calendar getPriceDate()

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

Returns:

the priceDate

setPriceDate

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

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

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

boolean isUseExternalPrice()

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

Returns:

the useExternalPrice

setUseExternalPrice

void setUseExternalPrice(boolean useExternalPrice)

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

Parameters:

useExternalPrice - the useExternalPrice to set

getLocale

java.lang.String getLocale()

Locale of the customer

Returns:

the locale

setLocale

void setLocale(java.lang.String locale)

Locale of the customer

Parameters:

locale - the locale to set

isUseExternalQuantity

boolean isUseExternalQuantity()

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

Returns:

the useExternalQuantity

setUseExternalQuantity

void setUseExternalQuantity(boolean useExternalQuantity)

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

Parameters:

useExternalQuantity - the useExternalQuantity to set

getBillingAddrId

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

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

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

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

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

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