CreateOrderOptionsIf (KonaKart Server Engine API Documentation)

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

All Methods Instance Methods Abstract Methods
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.

- 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
  - isCalcQuantityForBundles
```
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
```
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
  - getCouponCode
```
java.lang.String getCouponCode()
```
    The value of the coupon code to use when creating the order
    
    Returns:
    
    the couponCode
  - setCouponCode
```
void setCouponCode(java.lang.String couponCode)
```
    The value of the coupon code to use when creating the order
    
    Parameters:
    
    couponCode - the couponCode to set
  - getGiftCertCode
```
java.lang.String getGiftCertCode()
```
    The value of the gift certificate code to use when creating the order
    
    Returns:
    
    the giftCertCode
  - setGiftCertCode
```
void setGiftCertCode(java.lang.String giftCertCode)
```
    The value of the gift certificate code to use when creating the order
    
    Parameters:
    
    giftCertCode - the giftCertCode to set
  - isPopulateAvailableShippingQuotes
```
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.
    
    Returns:
    
    the populateAvailableShippingQuotes
  - setPopulateAvailableShippingQuotes
```
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.
    
    Parameters:
    
    populateAvailableShippingQuotes - the populateAvailableShippingQuotes to set
  - getShippingModuleCode
```
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.
    
    Returns:
    
    the shippingModuleCode
  - setShippingModuleCode
```
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.
    
    Parameters:
    
    shippingModuleCode - the shippingModuleCode to set
  - getShippingServiceCode
```
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.
    
    Returns:
    
    the shippingServiceCode
  - setShippingServiceCode
```
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.
    
    Parameters:
    
    shippingServiceCode - the shippingServiceCode to set
  - isPopulateAvailablePaymentGateways
```
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.
    
    Returns:
    
    the populateAvailablePaymentGateways
  - setPopulateAvailablePaymentGateways
```
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.
    
    Parameters:
    
    populateAvailablePaymentGateways - the populateAvailablePaymentGateways to set
  - getPaymentModuleCode
```
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.
    
    Returns:
    
    the paymentModuleCode
  - setPaymentModuleCode
```
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.
    
    Parameters:
    
    paymentModuleCode - the paymentModuleCode to set
  - getPaymentModuleSubCode
```
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.
    
    Returns:
    
    the paymentModuleSubCode
  - setPaymentModuleSubCode
```
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.
    
    Parameters:
    
    paymentModuleSubCode - the paymentModuleSubCode to set
  - isPopulateOrderTotals
```
boolean isPopulateOrderTotals()
```
    When set to true, the order is populated with its order total modules.
    
    Returns:
    
    the populateOrderTotals
  - setPopulateOrderTotals
```
void setPopulateOrderTotals(boolean populateOrderTotals)
```
    When set to true, the order is populated with its order total modules.
    
    Parameters:
    
    populateOrderTotals - the populateOrderTotals to set
  - isGetImages
```
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.
    
    Returns:
    
    the getImages
  - setGetImages
```
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.
    
    Parameters:
    
    getImages - the getImages to set
  - getInventoryUpdateExcludeProdTypes
```
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
    Returns:
    
    the inventoryUpdateExcludeProdTypes
  - setInventoryUpdateExcludeProdTypes
```
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
    Parameters:
    
    inventoryUpdateExcludeProdTypes - the inventoryUpdateExcludeProdTypes to set
  - getCurrencyCode
```
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
    
    Returns:
    
    the currencyCode
  - setCurrencyCode
```
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
    
    Parameters:
    
    currencyCode - the currencyCode to set

Interface CreateOrderOptionsIf

Method Summary

Method Detail

isCopyBasketCustomFields

setCopyBasketCustomFields

isUseDefaultCustomer

setUseDefaultCustomer

getCatalogId

setCatalogId

getPriceDate

setPriceDate

isUseWishListShippingAddr

setUseWishListShippingAddr

isUseExternalPrice

setUseExternalPrice

getLocale

setLocale

isUseExternalQuantity

setUseExternalQuantity

getBillingAddrId

setBillingAddrId

getCustomerAddrId

setCustomerAddrId

getDeliveryAddrId

setDeliveryAddrId

isCalcQuantityForBundles

setCalcQuantityForBundles

getCouponCode

setCouponCode

getGiftCertCode

setGiftCertCode

isPopulateAvailableShippingQuotes

setPopulateAvailableShippingQuotes

getShippingModuleCode

setShippingModuleCode

getShippingServiceCode

setShippingServiceCode

isPopulateAvailablePaymentGateways

setPopulateAvailablePaymentGateways

getPaymentModuleCode

setPaymentModuleCode

getPaymentModuleSubCode

setPaymentModuleSubCode

isPopulateOrderTotals

setPopulateOrderTotals

isGetImages

setGetImages

getInventoryUpdateExcludeProdTypes

setInventoryUpdateExcludeProdTypes

getCurrencyCode

setCurrencyCode