com.konakart.bl

Class StoreMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.StoreMgr

All Implemented Interfaces:

StoreMgrIf

public class StoreMgr
extends BaseMgr
implements StoreMgrIf

Manages all business logic relevant to the management of Stores for the Application Engine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StoreMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex Mutex for the Manager
protected static java.util.Map<java.lang.String,StoreMgr.StaticData>	staticDataHM Hash Map that contains the static data
protected static int	STORE_STATUS_TIMEOUT_SECS we read the store status from the db if it is older than this number of secs

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
StoreMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	doesStoreExist(java.lang.String storeId) Return true if the store exists.
java.lang.String[]	getActiveStores() Get a list of the active stores from the database.
Address[]	getAddressesPerStore(java.lang.String storeId) Returns all of the addresses for the given store.
Store	getStore() Returns the store that this KonaKart engine is connected to.
Store	getStoreForId(java.lang.String vendorStoreId) Returns the store referenced by the storeId parameter.
protected Store	getStoreForIdPrivate(java.lang.String vendorStoreId) Returns the store referenced by the storeId parameter.
java.lang.String[]	getStores() Get a list of stores from the database
Store	getStoreStatusById(java.lang.String storeId, boolean forceRefresh) Return the status elements of the Store object from the database with the specified storeId.
protected Store	getStoreStatusByIdPrivate(java.lang.String storeId) Return the status elements of the Store object from the database with the specified storeId
protected void	setCriteriaWithStandardAttributes(KKCriteria c) Set Standard Criteria
protected void	setCriteriaWithStatusAttributes(KKCriteria c) Set Criteria with status attributes

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

STORE_STATUS_TIMEOUT_SECS

protected static final int STORE_STATUS_TIMEOUT_SECS

we read the store status from the db if it is older than this number of secs

See Also:

Constant Field Values

log

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

the log

mutex

protected static java.lang.String mutex

Mutex for the Manager

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

StoreMgr

public StoreMgr(KKEngIf eng)
         throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

doesStoreExist

public boolean doesStoreExist(java.lang.String storeId)
                       throws org.apache.torque.TorqueException

Return true if the store exists.

Specified by:

doesStoreExist in interface StoreMgrIf

Parameters:

storeId - store id

Returns:

True if the Store exists

Throws:

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

getStores

public java.lang.String[] getStores()
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException

Get a list of stores from the database

Specified by:

getStores in interface StoreMgrIf

Returns:

an array of Store names - from 0 to n elements

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)

getActiveStores

public java.lang.String[] getActiveStores()
                                   throws org.apache.torque.TorqueException,
                                          com.workingdogs.village.DataSetException

Get a list of the active stores from the database. Active stores are enabled stores not under maintenance or deleted.

Specified by:

getActiveStores in interface StoreMgrIf

Returns:

an array of Store names - from 0 to n elements - ordered by storeId

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)

getStoreStatusById

public Store getStoreStatusById(java.lang.String storeId,
                                boolean forceRefresh)
                         throws com.konakart.app.KKException

Return the status elements of the Store object from the database with the specified storeId. Since this method is called on every API call, to improve performance the status is cached and refreshed after a programmable number of seconds. A forced refresh of the cache occurs if forceRefresh is set to true.

Specified by:

getStoreStatusById in interface StoreMgrIf

Parameters:

storeId - the storeId of the Store object to retrieve.

forceRefresh - When set, the cached data is refreshed from the database

Returns:

a partly-filled Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getStoreStatusByIdPrivate

protected Store getStoreStatusByIdPrivate(java.lang.String storeId)
                                   throws com.konakart.app.KKException

Return the status elements of the Store object from the database with the specified storeId

Parameters:

storeId - the storeId of the Store object to retrieve.

Returns:

a partly-filled Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getStore

public Store getStore()
               throws com.konakart.app.KKException,
                      org.apache.torque.TorqueException,
                      com.workingdogs.village.DataSetException

Returns the store that this KonaKart engine is connected to.

Specified by:

getStore in interface StoreMgrIf

Returns:

Returns a Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException 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)

getStoreForId

public Store getStoreForId(java.lang.String vendorStoreId)
                    throws java.lang.Exception

Returns the store referenced by the storeId parameter. It can only be called when in multi-vendor mode which assumes there is a single DB and products are shared.

Specified by:

getStoreForId in interface StoreMgrIf

Parameters:

vendorStoreId - the vendorStoreId

Returns:

Returns a Store object or null if the store isn't found

Throws:

java.lang.Exception - an unexpected exception

getStoreForIdPrivate

protected Store getStoreForIdPrivate(java.lang.String vendorStoreId)
                              throws com.konakart.app.KKException,
                                     org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException

Returns the store referenced by the storeId parameter.

Parameters:

vendorStoreId - the vendorStoreId

Returns:

Returns a Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException 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)

getAddressesPerStore

public Address[] getAddressesPerStore(java.lang.String storeId)
                               throws java.lang.Exception

Returns all of the addresses for the given store. Returns an empty array if the storeId parameter is set to null or no addresses exist.

Specified by:

getAddressesPerStore in interface StoreMgrIf

Parameters:

storeId - the storeId

Returns:

An array of address objects

Throws:

java.lang.Exception - an unexpected exception

setCriteriaWithStatusAttributes

protected void setCriteriaWithStatusAttributes(KKCriteria c)

Set Criteria with status attributes

Parameters:

c - the c

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(KKCriteria c)

Set Standard Criteria

Parameters:

c - the c