com.konakartadmin.bl

Class AdminShipmentMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminShipmentMgr

All Implemented Interfaces:

AdminShipmentMgrIf

public class AdminShipmentMgr
extends AdminBaseMgr
implements AdminShipmentMgrIf

The AdminShipmentMgr - for managing shippers and order shipments

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

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
AdminShipmentMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addOrderShipmentsToOrder(AdminOrder order) Get an array of order shipment objects for this order and attach them to the order
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	deleteOrderShipment(int orderShipmentId) Delete the AdminOrderShipment object and any associated AdminOrderShipmentProduct objects
int	deleteShipper(int shipperId) Delete a Shipper
void	editOrderShipment(AdminOrderShipment orderShipment) Edits an AdminOrderShipment object.
protected int	findOrderProduct(AdminOrderProduct[] opArray, AdminOrderProduct op) Returns the id of the Order Product from the parent order that matches the Order Product from the vendor order
AdminOrderShipmentSearchResult	getOrderShipments(AdminOrderShipmentSearch shipSearch, int offset, int size)
protected int	getShipmentsCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
AdminShipper	getShipper(int shipperId) Get a shipper by id
AdminShipperSearchResult	getShippers(AdminShipperSearch search) This returns an AdminShipperSearchResult object matching the search constraints
int	insertOrderShipment(AdminOrderShipment orderShipment) Inserts an AdminOrderShipment object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were shipped.
int	insertOrderShipmentPrivate(AdminOrderShipment orderShipment, java.util.Date creationDate, boolean insertForParent, java.lang.String storeId) Inserts an AdminOrderShipment object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were shipped.
int	insertShipper(AdminShipper shipper) Insert a Shipper
protected void	insertVendorParentOrderShipment(AdminOrderShipment orderShipment, java.util.Date creationDate) Insert the OrderShipment object for the parent order when in multi-vendor mode.
void	refreshConfigs() Refresh the configuration of the Manager
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

Constructor Detail

AdminShipmentMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Manager

Specified by:

refreshConfigs in interface AdminShipmentMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

insertOrderShipment

public int insertOrderShipment(AdminOrderShipment orderShipment)
                        throws java.lang.Exception

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

Specified by:

insertOrderShipment in interface AdminShipmentMgrIf

Parameters:

orderShipment - the orderShipment

Returns:

Returns the id of the newly inserted AdminOrderShipment object

Throws:

java.lang.Exception - an unexpected exception

insertOrderShipmentPrivate

public int insertOrderShipmentPrivate(AdminOrderShipment orderShipment,
                                      java.util.Date creationDate,
                                      boolean insertForParent,
                                      java.lang.String storeId)
                               throws java.lang.Exception

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

Parameters:

orderShipment - the orderShipment

creationDate - Used as the creation date when not null

insertForParent - When true we insert in the parent order when in multi-vendor mode

storeId - To insert an OrderShipment in multi-vendor mode

Returns:

Returns the id of the newly inserted AdminOrderShipment object

Throws:

java.lang.Exception - an unexpected exception

insertVendorParentOrderShipment

protected void insertVendorParentOrderShipment(AdminOrderShipment orderShipment,
                                               java.util.Date creationDate)
                                        throws java.lang.Exception

Insert the OrderShipment object for the parent order when in multi-vendor mode. Use the same creation date so that the OrderShipment can be identified.

Parameters:

orderShipment - the orderShipment

creationDate - the creation date

Throws:

java.lang.Exception - an unexpected exception

findOrderProduct

protected int findOrderProduct(AdminOrderProduct[] opArray,
                               AdminOrderProduct op)

Returns the id of the Order Product from the parent order that matches the Order Product from the vendor order

Parameters:

opArray - Order Product array from parent order

op - Order Product from vendor order

Returns:

Returns the id of the Order Product from the parent order that matches the Order Product from the vendor order

editOrderShipment

public void editOrderShipment(AdminOrderShipment orderShipment)
                       throws java.lang.Exception

Edits an AdminOrderShipment object.

Specified by:

editOrderShipment in interface AdminShipmentMgrIf

Parameters:

orderShipment - the orderShipment

Throws:

java.lang.Exception - an unexpected exception

deleteOrderShipment

public void deleteOrderShipment(int orderShipmentId)
                         throws java.lang.Exception

Delete the AdminOrderShipment object and any associated AdminOrderShipmentProduct objects

Specified by:

deleteOrderShipment in interface AdminShipmentMgrIf

Parameters:

orderShipmentId - the orderShipmentId

Throws:

java.lang.Exception - an unexpected exception

addOrderShipmentsToOrder

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

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

Specified by:

addOrderShipmentsToOrder in interface AdminShipmentMgrIf

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

getOrderShipments

public AdminOrderShipmentSearchResult getOrderShipments(AdminOrderShipmentSearch shipSearch,
                                                        int offset,
                                                        int size)
                                                 throws KKAdminException,
                                                        org.apache.torque.TorqueException,
                                                        com.workingdogs.village.DataSetException

Specified by:

getOrderShipments in interface AdminShipmentMgrIf

Parameters:

shipSearch - the shipSearch

offset - the offset

size - the size

Returns:

Return an AdminShipments 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)

getShipmentsCount

protected int getShipmentsCount(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

Specified by:

getShippers in interface AdminShipmentMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getShipper

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

Get a shipper by id

Specified by:

getShipper in interface AdminShipmentMgrIf

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 - unexpected exception in the KonaKart Admin Engine

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

Specified by:

insertShipper in interface AdminShipmentMgrIf

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 - unexpected exception in the KonaKart Admin Engine

updateShipper

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

Update a Shipper

Specified by:

updateShipper in interface AdminShipmentMgrIf

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 - unexpected exception in the KonaKart Admin Engine

deleteShipper

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

Delete a Shipper

Specified by:

deleteShipper in interface AdminShipmentMgrIf

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 - unexpected exception in the KonaKart Admin Engine