com.konakartadmin.bl

Class AdminOrderMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminOrderMgr

All Implemented Interfaces:

AdminOrderMgrIf

Direct Known Subclasses:

AdminOrderMgrEE

public class AdminOrderMgr
extends AdminBaseMgr
implements AdminOrderMgrIf

The AdminOrderMgr - for Managing Orders for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminOrderMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Boolean	customAttrAnOracleCLOB is Oracle CLOB used for custom_attrs column on the orders_products table?
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex Mutex for this manager
protected static java.util.Map<java.lang.String,AdminOrderMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminOrderMgr(KKAdminIf eng)

Method Summary

Modifier and Type	Method and Description
protected void	addOrderRefundsToOrder(AdminOrder order) Get an array of order refund objects for this order and attach them to the order
protected void	addOrderReturnStatusOrderBy(com.konakart.db.KKCriteria c, AdminOrderReturnStatusSearch search)
protected int	addOrderReturnStatusSearchCriteria(com.konakart.db.KKCriteria c, AdminOrderReturnStatusSearch search)
protected void	addOrderReturnsToOrder(AdminOrder order) Get an array of order return objects for this order and attach them to the order
protected int	addOrderSearchCriteria(com.konakart.db.KKCriteria c, AdminOrderSearch orderSearch)
protected void	addOrdersOrderBy(com.konakart.db.KKCriteria c, AdminOrderSearch orderSearch)
protected void	addOrderStatusOrderBy(com.konakart.db.KKCriteria c, AdminOrderStatusNameSearch search)
protected int	addOrderStatusSearchCriteria(com.konakart.db.KKCriteria c, AdminOrderStatusNameSearch search)
protected void	addShipperOrderBy(com.konakart.db.KKCriteria c, AdminShipperSearch search) Adds order by criteria for returning Shipper objects
protected int	addShipperSearchCriteria(com.konakart.db.KKCriteria c, AdminShipperSearch search) Adds search criteria for returning Shipper objects
void	calculateTotals(int scale, int taxQuantityRule, AdminOrderProduct orderProduct) We calculate totalPriceIncTax, totalPriceExTax and tax starting from price which is the price of one product without options and without tax.
void	decryptOrder(AdminOrder order) Decrypt the encrypted parts of an order - but only if the encryption key passed in is non-null and not empty.
void	deleteIpnHistory(int ipnHistoryId) Deletes an IPNHistory record by it's Id
int	deleteOrder(int ordId) Deletes an order and all associated records (eg OrderProducts, OrderStatusHistory etc)
int	deleteOrder(int ordId, boolean allStores) Deletes an order and all associated records (eg OrderProducts, OrderStatusHistory etc) from the current store.
void	deleteOrderRefund(int orderRefundId) Delete the AdminOrderRefund object
void	deleteOrderReturn(int orderRetId) Delete the AdminOrderReturn object and any associated AdminOrderReturnProduct objects
int	deleteOrderReturnStatus(int ordRetStatId) Delete an OrderReturnStatus
int	deleteOrderStatusName(int ordStatId) Delete an OrderStatusName
int	deleteShipper(int shipperId) Delete a Shipper
protected boolean	doesOrderExist(int orderId) Returns true if the parameter orderId points to an order in the database - in the current store.
protected boolean	doesOrderExist(int orderId, boolean allStores) Returns true if the parameter orderId points to an order in the database.
protected boolean	doesOrderReturnStatusExist(int orderReturnStatusId) Checks to see whether an Order Return Status already exists with this id for any language.
protected boolean	doesOrderReturnStatusExist(int orderReturnStatusId, int langId) Checks to see whether an Order Return Status already exists with this id and this language id.
protected boolean	doesOrderStatusExist(int status) Determines whether an order_status record exists for the status id parameter
boolean	doesOrderStatusExist(int ordStatId, int langId) Checks to see whether an Order Status already exists with this id and this language id.
void	editOrder(AdminOrder order) Edit an existing order.
void	editOrderRefund(AdminOrderRefund orderRefund) Edits an AdminOrderRefund object.
void	editOrderReturn(AdminOrderReturn orderRet) Edits an AdminOrderReturn object.
AdminCreditCard	encryptCreditCard(AdminCreditCard creditCard, java.lang.String ek) Encrypt the credit card details - but only if the encryption key passed in is non-null and not empty.
com.konakart.app.ExportOrderResponse	exportOrder(com.konakart.app.ExportOrderOptions options) Exports the Order
com.konakart.app.ExportOrderResponse	exportOrderByShippingModule(com.konakart.app.ExportOrderOptions options) Export an order to XML by using the respective Shipping Module to export the order.
com.konakart.app.ExportOrderResponse	exportOrderToXml(com.konakart.app.ExportOrderOptions options) Export an order to XML
com.konakart.app.ExportOrderResponse	exportOrderToXmlString(com.konakart.app.ExportOrderOptions options) Export an order to an XML String
protected void	formatOrderAddresses(AdminOrder order) It gets the address templates for all three addresses and sets the formatted addresses
protected AdminOrderIntegrationMgrInterface	getAdminOrderIntegMgrInstanceByName(java.lang.String className) Called to instantiate an AdminOrderIntegrationMgr.
protected AdminOrderIntegrationMgrInterface	getAdminOrderIntegrationMgr() Used to get an instance of the OrderIntegrationMgr
AdminOrderReturnStatus[]	getAllOrderReturnStatuses(int languageId) Returns an array of AdminOrderReturnStatus objects for the languages specified
AdminOrderStatusName[]	getAllOrderStatuses(int languageId) Returns an array of AdminOrdersStatusName objects for the languages specified
protected void	getArchivedOrders(AdminOrder order, int languageId, boolean allStores) Get the archived orders for the order
protected int	getCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
java.lang.String	getCouponCode(java.lang.String options) This method may be customized in the OrderIntegrationMgr to implement an algorithm that creates a coupon code or to read a coupon code from an external source.
protected java.lang.String	getCustomAttrs(int orderProductId) Get the custom_attrs for the order product with the specified orderProductId.
protected java.lang.String	getCustomAttrs(int orderProductId, java.sql.Connection con) Get the custom_attrs for the order product with the specified Id.
protected java.lang.String	getEncryptionKey(int orderId) Returns the encryption key used on an Order
protected int	getIpnCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
int	getOrderCount(int orderStatus) Returns a count of the Orders with the specified order status
protected void	getOrderCountryAndZone(AdminOrder order) Instantiate the Country and Zone objects for the order
protected void	getOrderDetails(AdminOrder order, int languageId, boolean allStores) Calls methods to get all of the details of the order
AdminOrder	getOrderForExport(int orderId) Return the AdminOrder with the specified orderId.
AdminOrder	getOrderForOrderId(int orderId) Retrieve an order for an orderId, using the default language
AdminOrder	getOrderForOrderId(int orderId, int languageId) Returns an order for an orderId and a languageId.
AdminOrder	getOrderForOrderId(int orderId, int languageId, boolean allStores) Returns an order for an orderId and a languageId.
protected void	getOrderProducts(AdminOrder[] orders, boolean allStores) Get the OrderProducts and the Options of each OrderProduct for the orders in the array
protected void	getOrderProducts(AdminOrder order, boolean allStores) Get the OrderProduct and the Options of each OrderProduct for this order.
AdminOrderRefundSearchResult	getOrderRefunds(AdminOrderRefundSearch retSearch, int offset, int size) Search for Order Refunds
AdminOrderReturnSearchResult	getOrderReturns(AdminOrderReturnSearch retSearch, int offset, int size) Search for Order Returns
protected int	getOrderReturnStatus(int orderRetId) Get the current status of an order return
AdminOrderReturnStatusSearchResult	getOrderReturnStatuses(AdminOrderReturnStatusSearch search) This returns an AdminOrderReturnStatusSearchResult object.
AdminOrderSearchResult	getOrders(AdminOrderSearch search, int offset, int size, int languageId) Returns a set of Orders matching the specified search criteria
AdminOrder[]	getOrdersCreatedSince(java.util.Calendar since, int languageId) Returns a set of Orders created since the specified date
AdminOrderSearchResult	getOrdersLite(AdminOrderSearch search, int offset, int size, int languageId) Returns a set of Orders matching the specified search criteria - the orders returned are sparsely-populated for performance.
AdminOrderStatusNameSearchResult	getOrderStatusNames(AdminOrderStatusNameSearch search) This returns an AdminOrderStatusNameSearchResult object.
protected void	getOrderTotals(AdminOrder order, boolean allStores) Populates the Order object with an array of OrderTotal objects sorted by the sortOrder attribute
protected int	getRefundsCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
protected int	getReturnsCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
java.lang.String	getRMACode(int orderId) This method may be customized in the OrderIntegrationMgr to implement an algorithm that creates an RMA code for the order.
AdminShipper	getShipper(int shipperId) Get a shipper by id
AdminShipperSearchResult	getShippers(AdminShipperSearch search) This returns an AdminShipperSearchResult object matching the search constraints
protected void	getStatusTrail(AdminOrder order, int languageId, boolean allStores) Populates the Order object with an array of OrderStatusHistory objects
int	insertIpnHistory(AdminIpnHistory ipnHistory) Save the AdminIpnHistory object in the database.
int	insertOrder(AdminOrder order) Insert an order
int	insertOrderRefund(AdminOrderRefund orderRefund) Inserts an AdminOrderRefund object
int	insertOrderReturn(AdminOrderReturn orderRet) Inserts an AdminOrderReturn object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were returned.
int	insertOrderReturnStatus(AdminOrderReturnStatus ordRetStat) Insert an AdminOrderReturnStatus object
int	insertOrderReturnStatuses(AdminOrderReturnStatus[] ordRetStats) Insert an array of AdminOrderReturnStatus objects.
int	insertOrderStatusName(AdminOrderStatusName ordStat) Insert an AdminOrderStatusName object
int	insertOrderStatusNames(AdminOrderStatusName[] ordStats) Insert an array of AdminOrderStatusName objects.
int	insertShipper(AdminShipper shipper) Insert a Shipper
static boolean	isCustomAttrAnOracleCLOB() Is the custom_attrs column is an Oracle CLOB? We only check once and save the result in a static variable.
protected boolean	isEnhancedVariantHandlingModeEnabled() Check in the static data if enhanced variant handling mode is enabled.
boolean	isSaveCreditCardDetails() If true, credit card details will be saved
void	refreshConfigs() Refresh the Configuration variables for this manager
AdminIpnHistories	searchForIpnHistory(AdminDataDescriptor dataDesc, AdminIpnSearch ipnSearch) Search for IPN History objects
void	setCreditCardDetailsOnOrder(AdminCreditCard creditCard) Set Credit Card details on an existing order
protected void	setCriteriaForEncyptionCols(com.konakart.db.KKCriteria c) Set the criteria object with all of the encryption attributes for a "Lite" order
protected void	setCriteriaWithJoinsLite(com.konakart.db.KKCriteria c, int languageId) Set the criteria object with all of the attributes for a "Lite" order
protected void	setCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c, int languageId) Set the criteria object with all of the attributes for an order
protected void	setCriteriaWithStandardAttributesLite(com.konakart.db.KKCriteria c, int languageId) Set the criteria object with all of the attributes for a "Lite" order
void	setRewardPointReservationId(int orderId, int reservationId) Updates the reward point reservation id for the order identified by orderId.
protected void	setupStoreCreditCardDetails(AdminOrderMgr.StaticData sd) Set the pre-search string based on the configuration variable value
void	updateOrder(int orderId, int orderStatus, java.lang.String comments, boolean notifyCustomer, AdminOrderUpdate updateOrder) Update the order status with optional comments.
void	updateOrder(int orderId, int orderStatus, java.lang.String comments, boolean notifyCustomer, AdminOrderUpdate _updateOrder, java.lang.String storeId) Update the order status with optional comments.
int	updateOrderReturnStatus(AdminOrderReturnStatus ordRetStat) Update an AdminOrderReturnStatus object
void	updateOrderStatus(int orderId, int orderStatus, java.lang.String comments, boolean notifyCustomer) Update the order status with optional comments
int	updateOrderStatusName(AdminOrderStatusName ordStat) Update an AdminOrderStatusName object
int	updateShipper(AdminShipper shipper) Update a Shipper

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

Mutex for this manager

staticDataHM

protected static java.util.Map<java.lang.String,AdminOrderMgr.StaticData> staticDataHM

Hash Map that contains the static data

customAttrAnOracleCLOB

public static java.lang.Boolean customAttrAnOracleCLOB

is Oracle CLOB used for custom_attrs column on the orders_products table?

Constructor Detail

AdminOrderMgr

public AdminOrderMgr(KKAdminIf eng)
              throws java.lang.Exception

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

setupStoreCreditCardDetails

protected void setupStoreCreditCardDetails(AdminOrderMgr.StaticData sd)

Set the pre-search string based on the configuration variable value

Parameters:

sd - StaticData

getOrderCount

public int getOrderCount(int orderStatus)
                  throws org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException

Returns a count of the Orders with the specified order status

Specified by:

getOrderCount in interface AdminOrderMgrIf

Parameters:

orderStatus - the order status

Returns:

A count of the Orders with the specified type

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getCount

protected int getCount(com.konakart.db.KKCriteria c)
                throws org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the KKCriteria

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getIpnCount

protected int getIpnCount(com.konakart.db.KKCriteria c)
                   throws org.apache.torque.TorqueException,
                          com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getOrdersLite

public AdminOrderSearchResult getOrdersLite(AdminOrderSearch search,
                                            int offset,
                                            int size,
                                            int languageId)
                                     throws KKAdminException

Returns a set of Orders matching the specified search criteria - the orders returned are sparsely-populated for performance.

Specified by:

getOrdersLite in interface AdminOrderMgrIf

Parameters:

search - the Orders search criteria object (can be null)

offset - offset in the db

size - max number of records to return from the offset

languageId - the language Id - or it could be DEFAULT_LANG to use the default language

Returns:

A set of Orders that match the specified search criteria within an AdminOrderSearchResult object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

decryptOrder

public void decryptOrder(AdminOrder order)
                  throws KKAdminException

Decrypt the encrypted parts of an order - but only if the encryption key passed in is non-null and not empty.

Specified by:

decryptOrder in interface AdminOrderMgrIf

Parameters:

order - the order object that will be populated with the unencrypted attributes

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getOrders

public AdminOrderSearchResult getOrders(AdminOrderSearch search,
                                        int offset,
                                        int size,
                                        int languageId)
                                 throws java.lang.Exception

Returns a set of Orders matching the specified search criteria

Specified by:

getOrders in interface AdminOrderMgrIf

Parameters:

search - the Orders search criteria object (can be null)

offset - offset in the db

size - max number of records to return from the offset

languageId - the language Id - or it could be DEFAULT_LANG to use the default language

Returns:

A set of Orders that match the specified search criteria within an AdminOrderSearchResult object

Throws:

java.lang.Exception - an unexpected exception

getOrdersCreatedSince

public AdminOrder[] getOrdersCreatedSince(java.util.Calendar since,
                                          int languageId)
                                   throws java.lang.Exception

Returns a set of Orders created since the specified date

Specified by:

getOrdersCreatedSince in interface AdminOrderMgrIf

Parameters:

since - the date to use to define the range of orders to return

languageId - the language id

Returns:

a set of orders placed since the specified date. If there are no orders then an empty array is returned

Throws:

java.lang.Exception - an unexpected exception

getOrderTotals

protected void getOrderTotals(AdminOrder order,
                              boolean allStores)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

Populates the Order object with an array of OrderTotal objects sorted by the sortOrder attribute

Parameters:

order - the order

allStores - the allStores

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getOrderProducts

protected void getOrderProducts(AdminOrder order,
                                boolean allStores)
                         throws java.lang.Exception

Get the OrderProduct and the Options of each OrderProduct for this order.

Parameters:

order - the order

allStores - the allStores

Throws:

java.lang.Exception - an unexpected exception

getOrderProducts

protected void getOrderProducts(AdminOrder[] orders,
                                boolean allStores)
                         throws java.lang.Exception

Get the OrderProducts and the Options of each OrderProduct for the orders in the array

Parameters:

orders - the orders

allStores - the allStores

Throws:

java.lang.Exception - an unexpected exception

getOrderDetails

protected void getOrderDetails(AdminOrder order,
                               int languageId,
                               boolean allStores)
                        throws java.lang.Exception

Calls methods to get all of the details of the order

Parameters:

order - the order

languageId - the languageId

allStores - the allStores

Throws:

java.lang.Exception - an unexpected exception

getCustomAttrs

protected java.lang.String getCustomAttrs(int orderProductId)
                                   throws java.lang.Exception

Get the custom_attrs for the order product with the specified orderProductId. Enterprise only feature.

Parameters:

orderProductId - the orderProductId

Returns:

the custom_attrs as a String

Throws:

java.lang.Exception - an unexpected exception

getCustomAttrs

protected java.lang.String getCustomAttrs(int orderProductId,
                                          java.sql.Connection con)
                                   throws java.lang.Exception

Get the custom_attrs for the order product with the specified Id. Enterprise only feature.

Parameters:

orderProductId - the orderProductId

con - Connection for transaction

Returns:

the custom_attrs as a String

Throws:

java.lang.Exception - an unexpected exception

updateOrder

public void updateOrder(int orderId,
                        int orderStatus,
                        java.lang.String comments,
                        boolean notifyCustomer,
                        AdminOrderUpdate updateOrder)
                 throws java.lang.Exception

Description copied from interface: AdminOrderMgrIf

Update the order status with optional comments. If the locale attribute of the order is not null, it will be used to read the email template in the customer's preferred language. Otherwise the default language will be used.

Specified by:

updateOrder in interface AdminOrderMgrIf

Parameters:

orderId - the order id

orderStatus - the new Order Status

comments - if not null, these comments are added

notifyCustomer - if true the customer will be notified by email

updateOrder - contains order update data such as who updated the order

Throws:

java.lang.Exception - an unexpected exception

updateOrder

public void updateOrder(int orderId,
                        int orderStatus,
                        java.lang.String comments,
                        boolean notifyCustomer,
                        AdminOrderUpdate _updateOrder,
                        java.lang.String storeId)
                 throws java.lang.Exception

Description copied from interface: AdminOrderMgrIf

Update the order status with optional comments. If the locale attribute of the order is not null, it will be used to read the email template in the customer's preferred language. Otherwise the default language will be used.

Specified by:

updateOrder in interface AdminOrderMgrIf

Parameters:

orderId - the order id

orderStatus - the new Order Status

comments - if not null, these comments are added

notifyCustomer - if true the customer will be notified by email

_updateOrder - contains order update data such as who updated the order

storeId - This is useful for multi-vendor orders when we desire to pass the status change of the vendor order on to the parent order. If the storeId is set to a non null value we assume that the order belongs to the store with this id.

Throws:

java.lang.Exception - an unexpected exception

updateOrderStatus

public void updateOrderStatus(int orderId,
                              int orderStatus,
                              java.lang.String comments,
                              boolean notifyCustomer)
                       throws java.lang.Exception

Update the order status with optional comments

Specified by:

updateOrderStatus in interface AdminOrderMgrIf

Parameters:

orderId - the order id

orderStatus - the new Order Status

comments - if not null, these comments are added

notifyCustomer - if true the customer will be notified by email

Throws:

java.lang.Exception - an unexpected exception

getAdminOrderIntegrationMgr

protected AdminOrderIntegrationMgrInterface getAdminOrderIntegrationMgr()

Used to get an instance of the OrderIntegrationMgr

Returns:

Returns an OrderIntegrationMgr Object

getAdminOrderIntegMgrInstanceByName

protected AdminOrderIntegrationMgrInterface getAdminOrderIntegMgrInstanceByName(java.lang.String className)
                                                                         throws java.lang.InstantiationException,
                                                                                java.lang.IllegalAccessException,
                                                                                java.lang.ClassNotFoundException,
                                                                                java.lang.IllegalArgumentException,
                                                                                java.lang.reflect.InvocationTargetException

Called to instantiate an AdminOrderIntegrationMgr. It determines whether the AdminOrderIntegrationMgr has a constructor where KKAdmin is passed in and if it does, then this constructor is used. Otherwise the empty constructor is used.

Parameters:

className - the className

Returns:

Returns an instantiated Module

Throws:

java.lang.IllegalAccessException - an unexpected IllegalAccessException exception

java.lang.InstantiationException - an unexpected InstantiationException exception

java.lang.ClassNotFoundException - an unexpected ClassNotFoundException exception

java.lang.reflect.InvocationTargetException - an unexpected InvocationTargetException exception

java.lang.IllegalArgumentException - an unexpected IllegalArgumentException exception

getOrderForOrderId

public AdminOrder getOrderForOrderId(int orderId)
                              throws java.lang.Exception

Retrieve an order for an orderId, using the default language

Specified by:

getOrderForOrderId in interface AdminOrderMgrIf

Parameters:

orderId - the orderId

Returns:

Returns an AdminOrder object

Throws:

java.lang.Exception - an unexpected exception

getOrderForOrderId

public AdminOrder getOrderForOrderId(int orderId,
                                     int languageId)
                              throws java.lang.Exception

Returns an order for an orderId and a languageId. If the languageId is set to -1 then the default language is used.

Specified by:

getOrderForOrderId in interface AdminOrderMgrIf

Parameters:

orderId - the orderId

languageId - the languageId

Returns:

Returns an AdminOrder object

Throws:

java.lang.Exception - an unexpected exception

getOrderForOrderId

public AdminOrder getOrderForOrderId(int orderId,
                                     int languageId,
                                     boolean allStores)
                              throws java.lang.Exception

Returns an order for an orderId and a languageId. If the languageId is set to -1 then the default language is used.

Specified by:

getOrderForOrderId in interface AdminOrderMgrIf

Parameters:

orderId - the orderId

languageId - the languageId

allStores - the allStores

Returns:

Returns an AdminOrder object

Throws:

java.lang.Exception - an unexpected exception

getArchivedOrders

protected void getArchivedOrders(AdminOrder order,
                                 int languageId,
                                 boolean allStores)
                          throws java.lang.Exception

Get the archived orders for the order

Parameters:

order - the order

languageId - the languageId

allStores - the allStores

Throws:

java.lang.Exception - an unexpected exception

getEncryptionKey

protected java.lang.String getEncryptionKey(int orderId)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Returns the encryption key used on an Order

Parameters:

orderId - the orderId

Returns:

Returns the encryption key for the order or null if it doesn't exist

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

doesOrderStatusExist

protected boolean doesOrderStatusExist(int status)
                                throws org.apache.torque.TorqueException,
                                       KKAdminException

Determines whether an order_status record exists for the status id parameter

Parameters:

status - the status

Returns:

Returns true or false

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

formatOrderAddresses

protected void formatOrderAddresses(AdminOrder order)
                             throws java.lang.Exception

It gets the address templates for all three addresses and sets the formatted addresses

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception

getStatusTrail

protected void getStatusTrail(AdminOrder order,
                              int languageId,
                              boolean allStores)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

Populates the Order object with an array of OrderStatusHistory objects

Parameters:

order - the order

languageId - the languageId

allStores - the allStores

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getOrderCountryAndZone

protected void getOrderCountryAndZone(AdminOrder order)
                               throws java.lang.Exception

Instantiate the Country and Zone objects for the order

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception

getAllOrderStatuses

public AdminOrderStatusName[] getAllOrderStatuses(int languageId)
                                           throws java.lang.Exception

Returns an array of AdminOrdersStatusName objects for the languages specified

Specified by:

getAllOrderStatuses in interface AdminOrderMgrIf

Parameters:

languageId - the languageId

Returns:

Array of AdminOrdersStatusName objects

Throws:

java.lang.Exception - an unexpected exception

addOrdersOrderBy

protected void addOrdersOrderBy(com.konakart.db.KKCriteria c,
                                AdminOrderSearch orderSearch)

Parameters:

c - the c

orderSearch - the orderSearch

addOrderSearchCriteria

protected int addOrderSearchCriteria(com.konakart.db.KKCriteria c,
                                     AdminOrderSearch orderSearch)
                              throws KKAdminException,
                                     org.apache.torque.TorqueException

Parameters:

c - the c

orderSearch - the orderSearch

Returns:

Returns the number of constraints added

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

setCriteriaWithJoinsLite

protected void setCriteriaWithJoinsLite(com.konakart.db.KKCriteria c,
                                        int languageId)

Set the criteria object with all of the attributes for a "Lite" order

Parameters:

c - Criteria to add to

languageId - the language Id

setCriteriaWithStandardAttributesLite

protected void setCriteriaWithStandardAttributesLite(com.konakart.db.KKCriteria c,
                                                     int languageId)

Set the criteria object with all of the attributes for a "Lite" order

Parameters:

c - the c

languageId - the languageId

setCriteriaForEncyptionCols

protected void setCriteriaForEncyptionCols(com.konakart.db.KKCriteria c)

Set the criteria object with all of the encryption attributes for a "Lite" order

Parameters:

c - the c

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c,
                                                 int languageId)

Set the criteria object with all of the attributes for an order

Parameters:

c - the c

languageId - the languageId

calculateTotals

public void calculateTotals(int scale,
                            int taxQuantityRule,
                            AdminOrderProduct orderProduct)

We calculate totalPriceIncTax, totalPriceExTax and tax starting from price which is the price of one product without options and without tax. Added to the Mgr because we can't do sums on BigDecimal on the client.

Specified by:

calculateTotals in interface AdminOrderMgrIf

Parameters:

scale - The scale used in the calculations

taxQuantityRule - The tax calculation rule to use

orderProduct - the orderProduct

deleteOrder

public int deleteOrder(int ordId)
                throws KKAdminException

Deletes an order and all associated records (eg OrderProducts, OrderStatusHistory etc)

Removes records from :

• TABLE_ORDERS_PRODUCTS
• TABLE_ORDERS_PRODUCTS_ATTRIBUTES
• TABLE_ORDERS_PRODUCTS_DOWNLOAD
• TABLE_ORDERS_STATUS_HISTORY
• TABLE_ORDERS_TOTAL
• TABLE_ORDERS

Specified by:

deleteOrder in interface AdminOrderMgrIf

Parameters:

ordId - Order id of the order to delete

Returns:

return the order id of the deleted order

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

deleteOrder

public int deleteOrder(int ordId,
                       boolean allStores)
                throws KKAdminException

Deletes an order and all associated records (eg OrderProducts, OrderStatusHistory etc) from the current store.

Removes records from :

• TABLE_ORDERS_PRODUCTS
• TABLE_ORDERS_PRODUCTS_ATTRIBUTES
• TABLE_ORDERS_PRODUCTS_DOWNLOAD
• TABLE_ORDERS_STATUS_HISTORY
• TABLE_ORDERS_TOTAL
• TABLE_ORDERS

Specified by:

deleteOrder in interface AdminOrderMgrIf

Parameters:

ordId - Order id of the order to delete

allStores - if true the order is removed whichever store it is in. If false the order is only removed if it is found in the current store.

Returns:

return the order id of the deleted order

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getOrderStatusNames

public AdminOrderStatusNameSearchResult getOrderStatusNames(AdminOrderStatusNameSearch search)
                                                     throws org.apache.torque.TorqueException,
                                                            com.workingdogs.village.DataSetException,
                                                            KKAdminException

This returns an AdminOrderStatusNameSearchResult object.

Specified by:

getOrderStatusNames in interface AdminOrderMgrIf

Parameters:

search - the search

Returns:

Returns an AdminOrderStatusNameSearchResult object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

deleteOrderStatusName

public int deleteOrderStatusName(int ordStatId)
                          throws KKAdminException

Delete an OrderStatusName

Specified by:

deleteOrderStatusName in interface AdminOrderMgrIf

Parameters:

ordStatId - An OrderStatusName id

Returns:

returns the id of the deleted order status

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertOrderStatusName

public int insertOrderStatusName(AdminOrderStatusName ordStat)
                          throws KKAdminException

Insert an AdminOrderStatusName object

Specified by:

insertOrderStatusName in interface AdminOrderMgrIf

Parameters:

ordStat - An AdminOrderStatusName object

Returns:

returns the id of the inserted AdminOrderStatusName object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertOrderStatusNames

public int insertOrderStatusNames(AdminOrderStatusName[] ordStats)
                           throws KKAdminException

Insert an array of AdminOrderStatusName objects. We use the same id for all of the items in the array.

Specified by:

insertOrderStatusNames in interface AdminOrderMgrIf

Parameters:

ordStats - An AdminOrderStatusName array object

Returns:

returns the id of the last inserted AdminOrderStatusName objects

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

updateOrderStatusName

public int updateOrderStatusName(AdminOrderStatusName ordStat)
                          throws java.lang.Exception

Update an AdminOrderStatusName object

Specified by:

updateOrderStatusName in interface AdminOrderMgrIf

Parameters:

ordStat - An AdminOrderStatusName object

Returns:

returns the id of the updated AdminOrderStatusName object

Throws:

java.lang.Exception - an unexpected exception

doesOrderStatusExist

public boolean doesOrderStatusExist(int ordStatId,
                                    int langId)
                             throws org.apache.torque.TorqueException,
                                    KKAdminException

Checks to see whether an Order Status already exists with this id and this language id. If language Id is set to NOT_SET, we check only for orderstatuses with the specified order status id.

Specified by:

doesOrderStatusExist in interface AdminOrderMgrIf

Parameters:

ordStatId - the order status Id

langId - the language Id

Returns:

Returns true if the order status already exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

addOrderStatusOrderBy

protected void addOrderStatusOrderBy(com.konakart.db.KKCriteria c,
                                     AdminOrderStatusNameSearch search)

Parameters:

c - the c

search - the search

addOrderStatusSearchCriteria

protected int addOrderStatusSearchCriteria(com.konakart.db.KKCriteria c,
                                           AdminOrderStatusNameSearch search)

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

searchForIpnHistory

public AdminIpnHistories searchForIpnHistory(AdminDataDescriptor dataDesc,
                                             AdminIpnSearch ipnSearch)
                                      throws java.lang.Exception

Description copied from interface: AdminOrderMgrIf

Search for IPN History objects

Specified by:

searchForIpnHistory in interface AdminOrderMgrIf

Parameters:

dataDesc - the dataDesc

ipnSearch - the ipnSearch

Returns:

Return an AdminIpnHistories object

Throws:

java.lang.Exception - an unexpected exception

insertOrderReturn

public int insertOrderReturn(AdminOrderReturn orderRet)
                      throws java.lang.Exception

Inserts an AdminOrderReturn object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were returned.

Specified by:

insertOrderReturn in interface AdminOrderMgrIf

Parameters:

orderRet - the orderRet

Returns:

Returns the id of the newly inserted AdminOrderReturn object

Throws:

java.lang.Exception - an unexpected exception

editOrderReturn

public void editOrderReturn(AdminOrderReturn orderRet)
                     throws java.lang.Exception

Edits an AdminOrderReturn object.

Specified by:

editOrderReturn in interface AdminOrderMgrIf

Parameters:

orderRet - the orderRet

Throws:

java.lang.Exception - an unexpected exception

deleteOrderReturn

public void deleteOrderReturn(int orderRetId)
                       throws java.lang.Exception

Delete the AdminOrderReturn object and any associated AdminOrderReturnProduct objects

Specified by:

deleteOrderReturn in interface AdminOrderMgrIf

Parameters:

orderRetId - the orderRetId

Throws:

java.lang.Exception - an unexpected exception

getOrderReturnStatus

protected int getOrderReturnStatus(int orderRetId)
                            throws com.workingdogs.village.DataSetException,
                                   org.apache.torque.TorqueException,
                                   KKAdminException

Get the current status of an order return

Parameters:

orderRetId - The id of the order return

Returns:

Returns the status

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

addOrderReturnsToOrder

protected void addOrderReturnsToOrder(AdminOrder order)
                               throws KKAdminException,
                                      org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException

Get an array of order return objects for this order and attach them to the order

Parameters:

order - the order

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

getOrderReturns

public AdminOrderReturnSearchResult getOrderReturns(AdminOrderReturnSearch retSearch,
                                                    int offset,
                                                    int size)
                                             throws KKAdminException,
                                                    org.apache.torque.TorqueException,
                                                    com.workingdogs.village.DataSetException

Description copied from interface: AdminOrderMgrIf

Search for Order Returns

Specified by:

getOrderReturns in interface AdminOrderMgrIf

Parameters:

retSearch - the retSearch

offset - the offset

size - the size

Returns:

Return an AdminReturns object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getReturnsCount

protected int getReturnsCount(com.konakart.db.KKCriteria c)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

editOrder

public void editOrder(AdminOrder order)
               throws java.lang.Exception

Edit an existing order. This method only allows you to edit certain attributes of an order. In order to change the order status you must use updateOrder(). The attributes that can be modified are:

• Order and OrderProduct Custom fields
• Order Filter fields
• Payment Method
• Date Finished
• Order Number
• Tracking Number
• Order Invoice Filename
• Parent Id
• Refund value and points of OrderProducts

Attributes containing null values will be ignored. In order to clear a String attribute, you must set it to an empty string.

Specified by:

editOrder in interface AdminOrderMgrIf

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception

setCreditCardDetailsOnOrder

public void setCreditCardDetailsOnOrder(AdminCreditCard creditCard)
                                 throws java.lang.Exception,
                                        KKAdminException

Set Credit Card details on an existing order

This method only allows you to update the credit card details on an order. In order to change the order status you must use updateOrderStatus().

The Credit Card details are only saved if the ability to save credit card details is enabled in the configuration of the store.

The orderId must be populated in the id field of the AdminCreditCard object.

Before being saved, this sensitive information is encrypted.

No update or insert is done for attributes of the AdminCreditCard object that are set to null. The credit card details are mapped as follows to attributes in the order object:

• e1 - Credit Card owner
• e2 - Credit Card number
• e3 - Credit Card expiration
• e4 - Credit Card CVV
• e5 - Credit Card Type

The following Credit Card attributes can be saved (on the AdminCreditCard object):

• CC Type
• CC Owner
• CC Number
• CC Expires
• CC CVV

Specified by:

setCreditCardDetailsOnOrder in interface AdminOrderMgrIf

Parameters:

creditCard - the AdminCreditCard object

Throws:

java.lang.Exception - an unexpected exception

KKAdminException - unexpected exception in the KonaKart Admin Engine

encryptCreditCard

public AdminCreditCard encryptCreditCard(AdminCreditCard creditCard,
                                         java.lang.String ek)
                                  throws KKAdminException

Encrypt the credit card details - but only if the encryption key passed in is non-null and not empty. Null attributes are copied to the new encrypted credit card details.

Specified by:

encryptCreditCard in interface AdminOrderMgrIf

Parameters:

creditCard - the original credit card object

ek - the encryption key

Returns:

a new AdminCreditCard object with encrypted fields. If the original creditCard object is null, or the encryption key is null (or empty), a null is returned.

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

doesOrderExist

protected boolean doesOrderExist(int orderId)
                          throws org.apache.torque.TorqueException

Returns true if the parameter orderId points to an order in the database - in the current store.

Parameters:

orderId - the orderId

Returns:

Return true if the order exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

doesOrderExist

protected boolean doesOrderExist(int orderId,
                                 boolean allStores)
                          throws org.apache.torque.TorqueException

Returns true if the parameter orderId points to an order in the database.

Parameters:

orderId - the orderId

allStores - if true the order is searched for whichever store it is in. If false the order is only searched for in the current store.

Returns:

Return true if the order exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

insertIpnHistory

public int insertIpnHistory(AdminIpnHistory ipnHistory)
                     throws java.lang.Exception

Save the AdminIpnHistory object in the database.

Specified by:

insertIpnHistory in interface AdminOrderMgrIf

Parameters:

ipnHistory - the ipnHistory

Returns:

Id of newly created object

Throws:

java.lang.Exception - an unexpected exception

deleteIpnHistory

public void deleteIpnHistory(int ipnHistoryId)
                      throws KKAdminException

Deletes an IPNHistory record by it's Id

Specified by:

deleteIpnHistory in interface AdminOrderMgrIf

Parameters:

ipnHistoryId - IPN History id of the record to delete

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertOrder

public int insertOrder(AdminOrder order)
                throws java.lang.Exception

Insert an order

Specified by:

insertOrder in interface AdminOrderMgrIf

Parameters:

order - the order

Returns:

Returns the order Id

Throws:

java.lang.Exception - an unexpected exception

isSaveCreditCardDetails

public boolean isSaveCreditCardDetails()

Description copied from interface: AdminOrderMgrIf

If true, credit card details will be saved

Specified by:

isSaveCreditCardDetails in interface AdminOrderMgrIf

Returns:

the saveCreditCardDetails

exportOrder

public com.konakart.app.ExportOrderResponse exportOrder(com.konakart.app.ExportOrderOptions options)
                                                 throws KKAdminException

Description copied from interface: AdminOrderMgrIf

Exports the Order

Specified by:

exportOrder in interface AdminOrderMgrIf

Parameters:

options - Defines the options to use for the export of the Order

Returns:

an ExportOrderResponse object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

exportOrderToXmlString

public com.konakart.app.ExportOrderResponse exportOrderToXmlString(com.konakart.app.ExportOrderOptions options)
                                                            throws org.apache.torque.TorqueException,
                                                                   com.workingdogs.village.DataSetException,
                                                                   java.lang.Exception

Export an order to an XML String

Parameters:

options - export options in ExportOrderOptions

Returns:

an ExportOrderResponse object to indicate the result

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

exportOrderToXml

public com.konakart.app.ExportOrderResponse exportOrderToXml(com.konakart.app.ExportOrderOptions options)
                                                      throws org.apache.torque.TorqueException,
                                                             com.workingdogs.village.DataSetException,
                                                             java.lang.Exception

Export an order to XML

Parameters:

options - export options in ExportOrderOptions

Returns:

an ExportOrderResponse object to indicate the result

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

getOrderForExport

public AdminOrder getOrderForExport(int orderId)
                             throws KKAdminException

Return the AdminOrder with the specified orderId. Throws an exception if the order does not exist.

Parameters:

orderId - id of the order to retrieve

Returns:

the AdminOrder if found

Throws:

KKAdminException - if the order does not exist or there are other more serious problems

exportOrderByShippingModule

public com.konakart.app.ExportOrderResponse exportOrderByShippingModule(com.konakart.app.ExportOrderOptions options)
                                                                 throws KKAdminException

Export an order to XML by using the respective Shipping Module to export the order.

Parameters:

options - export options in ExportOrderOptions

Returns:

an ExportOrderResponse object to indicate the result

Throws:

KKAdminException - an unexpected KKAdminException exception

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the Configuration variables for this manager

Specified by:

refreshConfigs in interface AdminOrderMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

setRewardPointReservationId

public void setRewardPointReservationId(int orderId,
                                        int reservationId)
                                 throws java.lang.Exception

Updates the reward point reservation id for the order identified by orderId.

Specified by:

setRewardPointReservationId in interface AdminOrderMgrIf

Parameters:

orderId - the orderId

reservationId - the reservationId

Throws:

java.lang.Exception - an unexpected exception

insertOrderRefund

public int insertOrderRefund(AdminOrderRefund orderRefund)
                      throws java.lang.Exception

Inserts an AdminOrderRefund object

Specified by:

insertOrderRefund in interface AdminOrderMgrIf

Parameters:

orderRefund - the orderRefund

Returns:

Returns the id of the newly inserted AdminOrderRefund object

Throws:

java.lang.Exception - an unexpected exception

editOrderRefund

public void editOrderRefund(AdminOrderRefund orderRefund)
                     throws java.lang.Exception

Edits an AdminOrderRefund object.

Specified by:

editOrderRefund in interface AdminOrderMgrIf

Parameters:

orderRefund - the orderRefund

Throws:

java.lang.Exception - an unexpected exception

deleteOrderRefund

public void deleteOrderRefund(int orderRefundId)
                       throws java.lang.Exception

Delete the AdminOrderRefund object

Specified by:

deleteOrderRefund in interface AdminOrderMgrIf

Parameters:

orderRefundId - the orderRefundId

Throws:

java.lang.Exception - an unexpected exception

addOrderRefundsToOrder

protected void addOrderRefundsToOrder(AdminOrder order)
                               throws KKAdminException,
                                      org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException

Get an array of order refund objects for this order and attach them to the order

Parameters:

order - the order

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

getOrderRefunds

public AdminOrderRefundSearchResult getOrderRefunds(AdminOrderRefundSearch retSearch,
                                                    int offset,
                                                    int size)
                                             throws KKAdminException,
                                                    org.apache.torque.TorqueException,
                                                    com.workingdogs.village.DataSetException

Description copied from interface: AdminOrderMgrIf

Search for Order Refunds

Specified by:

getOrderRefunds in interface AdminOrderMgrIf

Parameters:

retSearch - the retSearch

offset - the offset

size - the size

Returns:

Return an AdminRefundSearchResult object

Throws:

KKAdminException - an unexpected KKAdminException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getRefundsCount

protected int getRefundsCount(com.konakart.db.KKCriteria c)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getShippers

public AdminShipperSearchResult getShippers(AdminShipperSearch search)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException,
                                            KKAdminException

This returns an AdminShipperSearchResult object matching the search constraints

Parameters:

search - the search

Returns:

Returns an AdminShipperSearchResult object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

getShipper

public AdminShipper getShipper(int shipperId)
                        throws org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException,
                               KKAdminException

Get a shipper by id

Parameters:

shipperId - the shipperId

Returns:

Returns an AdminShipper object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

addShipperSearchCriteria

protected int addShipperSearchCriteria(com.konakart.db.KKCriteria c,
                                       AdminShipperSearch search)

Adds search criteria for returning Shipper objects

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

addShipperOrderBy

protected void addShipperOrderBy(com.konakart.db.KKCriteria c,
                                 AdminShipperSearch search)

Adds order by criteria for returning Shipper objects

Parameters:

c - the c

search - the search

insertShipper

public int insertShipper(AdminShipper shipper)
                  throws org.apache.torque.TorqueException,
                         KKAdminException

Insert a Shipper

Parameters:

shipper - A shipper object

Returns:

returns the id of the inserted shipper object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

updateShipper

public int updateShipper(AdminShipper shipper)
                  throws org.apache.torque.TorqueException,
                         KKAdminException

Update a Shipper

Parameters:

shipper - A shipper object

Returns:

returns the id of the updated shipper

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

deleteShipper

public int deleteShipper(int shipperId)
                  throws org.apache.torque.TorqueException,
                         KKAdminException

Delete a Shipper

Parameters:

shipperId - A shipper id

Returns:

returns the id of the deleted shipper

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected KKAdminException exception

getRMACode

public java.lang.String getRMACode(int orderId)

This method may be customized in the OrderIntegrationMgr to implement an algorithm that creates an RMA code for the order. The Administration Application will use the returned value (if not null) to automatically populate the RMA code entry field.

Specified by:

getRMACode in interface AdminOrderMgrIf

Parameters:

orderId - Id of the order

Returns:

Returns an RMA Code

getCouponCode

public java.lang.String getCouponCode(java.lang.String options)

This method may be customized in the OrderIntegrationMgr to implement an algorithm that creates a coupon code or to read a coupon code from an external source.

Specified by:

getCouponCode in interface AdminOrderMgrIf

Parameters:

options - Optional parameter that may be used to control how the coupon code is generated

Returns:

Returns a coupon code

isCustomAttrAnOracleCLOB

public static boolean isCustomAttrAnOracleCLOB()

Is the custom_attrs column is an Oracle CLOB? We only check once and save the result in a static variable.

Returns:

the customAttrAnOracleCLOB

getOrderReturnStatuses

public AdminOrderReturnStatusSearchResult getOrderReturnStatuses(AdminOrderReturnStatusSearch search)
                                                          throws org.apache.torque.TorqueException,
                                                                 com.workingdogs.village.DataSetException,
                                                                 KKAdminException

This returns an AdminOrderReturnStatusSearchResult object.

Specified by:

getOrderReturnStatuses in interface AdminOrderMgrIf

Parameters:

search - the search

Returns:

Returns an AdminOrderReturnStatusSearchResult object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

deleteOrderReturnStatus

public int deleteOrderReturnStatus(int ordRetStatId)
                            throws KKAdminException

Delete an OrderReturnStatus

Specified by:

deleteOrderReturnStatus in interface AdminOrderMgrIf

Parameters:

ordRetStatId - An OrderReturnStatus id

Returns:

returns the id of the deleted order return status

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertOrderReturnStatus

public int insertOrderReturnStatus(AdminOrderReturnStatus ordRetStat)
                            throws KKAdminException

Insert an AdminOrderReturnStatus object

Specified by:

insertOrderReturnStatus in interface AdminOrderMgrIf

Parameters:

ordRetStat - An AdminOrderReturnStatus object

Returns:

returns the id of the inserted AdminOrderReturnStatus object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertOrderReturnStatuses

public int insertOrderReturnStatuses(AdminOrderReturnStatus[] ordRetStats)
                              throws KKAdminException

Insert an array of AdminOrderReturnStatus objects. We use the same id for all of the items in the array.

Specified by:

insertOrderReturnStatuses in interface AdminOrderMgrIf

Parameters:

ordRetStats - An AdminOrderReturnStatus array object

Returns:

returns the id of the last inserted AdminOrderReturnStatus objects

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

updateOrderReturnStatus

public int updateOrderReturnStatus(AdminOrderReturnStatus ordRetStat)
                            throws java.lang.Exception

Update an AdminOrderReturnStatus object

Specified by:

updateOrderReturnStatus in interface AdminOrderMgrIf

Parameters:

ordRetStat - An AdminOrderReturnStatus object

Returns:

returns the id of the updated AdminOrderReturnStatus object

Throws:

java.lang.Exception - an unexpected exception

doesOrderReturnStatusExist

protected boolean doesOrderReturnStatusExist(int orderReturnStatusId,
                                             int langId)
                                      throws org.apache.torque.TorqueException,
                                             KKAdminException

Checks to see whether an Order Return Status already exists with this id and this language id. If language Id is set to NOT_SET, we check only for order return statuses with the specified order status id.

Parameters:

orderReturnStatusId - the order return status Id

langId - the language Id

Returns:

Returns true if the order return status already exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

doesOrderReturnStatusExist

protected boolean doesOrderReturnStatusExist(int orderReturnStatusId)
                                      throws org.apache.torque.TorqueException,
                                             KKAdminException

Checks to see whether an Order Return Status already exists with this id for any language.

Parameters:

orderReturnStatusId - the order return status Id

Returns:

Returns true if the order return status already exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - unexpected exception in the KonaKart Admin Engine

addOrderReturnStatusOrderBy

protected void addOrderReturnStatusOrderBy(com.konakart.db.KKCriteria c,
                                           AdminOrderReturnStatusSearch search)

Parameters:

c - the c

search - the search

addOrderReturnStatusSearchCriteria

protected int addOrderReturnStatusSearchCriteria(com.konakart.db.KKCriteria c,
                                                 AdminOrderReturnStatusSearch search)

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

getAllOrderReturnStatuses

public AdminOrderReturnStatus[] getAllOrderReturnStatuses(int languageId)
                                                   throws java.lang.Exception

Returns an array of AdminOrderReturnStatus objects for the languages specified

Specified by:

getAllOrderReturnStatuses in interface AdminOrderMgrIf

Parameters:

languageId - the languageId

Returns:

Array of AdminOrderReturnStatus objects

Throws:

java.lang.Exception - an unexpected exception

isEnhancedVariantHandlingModeEnabled

protected boolean isEnhancedVariantHandlingModeEnabled()
                                                throws KKAdminException

Check in the static data if enhanced variant handling mode is enabled.

Returns:

true if is enabled

Throws:

KKAdminException - an unexpected KKAdminException exception