com.konakartadmin.bl

Class AdminCommunityStoreMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminCommunityStoreMgr

All Implemented Interfaces:

AdminStoreMgrIf

public class AdminCommunityStoreMgr
extends AdminBaseMgr
implements AdminStoreMgrIf

The AdminCommunityStoreMgr - for Store-related functions of the Admin Application for the Community version

Nested Class Summary

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

AdminBaseMgr.StaticData

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	cloneStore(AdminNewStoreOptions options, java.lang.String storeToCloneId, AdminStore newStore, int userId) Insert a new store into the mall by cloning a specified store.
void	deleteStoreDB(java.lang.String storeId) Delete a Store from the Database
boolean	doesStoreExistDB(java.lang.String storeId) Return true if the store exists.
protected void	doInit(KKAdminIf eng)
com.konakart.db.KKCriteria	getNewCriteria() Gets a new KKCriteria object from the super class ten takes off the storeId as we never want to add a where storeId= constraint when looking up these stores.
AdminStore	getStoreDBById(java.lang.String storeId) Return the AdminStore object from the database with the specified storeId
AdminStore[]	getStores(org.apache.commons.configuration2.Configuration kkConfig) Get the stores supported by the server.
AdminStore[]	getStores(java.lang.String configFile) Get the stores supported by the server.
AdminStoreSearchResult	getStoresDB(AdminStoreSearch search, int offset, int size) Return the AdminStore objects defined by the search criteria.
protected AdminStore[]	getStoresPrivate() Just returns the default single store list.
AdminStore	getStoreStatusById(java.lang.String storeId) Return the status elements of the AdminStore object from the database with the specified storeId
java.lang.String	insertStore(AdminStore insertObj, int userId) Insert an AdminStore object
void	removeStoreDB(java.lang.String storeId) Delete a Store from the Database - this doesn't just mark the store as deleted (that's what deleteStoreDB does) but it removes all the records for this store from the database.
void	updateStoreDB(AdminStore updateObj) Update an AdminStore object

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, 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, refreshConfigs, 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

Constructor Detail

AdminCommunityStoreMgr

public AdminCommunityStoreMgr(KKAdminIf eng)
                       throws KKAdminException

Constructor

Parameters:

eng - KKAdminIf Admin Engine

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

Method Detail

doInit

protected void doInit(KKAdminIf eng)
               throws KKAdminException

Parameters:

eng - the eng

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getStores

public AdminStore[] getStores(java.lang.String configFile)
                       throws KKAdminException

Get the stores supported by the server.

Specified by:

getStores in interface AdminStoreMgrIf

Parameters:

configFile - the name of the properties file

Returns:

an array of AdminStore objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getStores

public AdminStore[] getStores(org.apache.commons.configuration2.Configuration kkConfig)
                       throws KKAdminException

Get the stores supported by the server. This version uses a KonaKart Configuration that has already been read rather than read a new one every time.

Specified by:

getStores in interface AdminStoreMgrIf

Parameters:

kkConfig - A configuration that has already been read

Returns:

an array of AdminStore objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getStoresPrivate

protected AdminStore[] getStoresPrivate()

Just returns the default single store list.

Returns:

an array of AdminStore objects (actually the array always has just 1 element)

getStoresDB

public AdminStoreSearchResult getStoresDB(AdminStoreSearch search,
                                          int offset,
                                          int size)
                                   throws KKAdminException

Return the AdminStore objects defined by the search criteria.

Specified by:

getStoresDB in interface AdminStoreMgrIf

Parameters:

search - the Admin Store search object that defines the AdminStore objects to search for. If null we use the default AdminStoreSearch object.

offset - starting offset in database - so that you can page through results

size - size of the group that will be returned - the maximum number of records returned. If this is set to -1 (KonakartAdminConstants.NOT_SET) no limit is imposed.

Returns:

an AdminStoreSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getStoreStatusById

public AdminStore getStoreStatusById(java.lang.String storeId)
                              throws KKAdminException

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

Specified by:

getStoreStatusById in interface AdminStoreMgrIf

Parameters:

storeId - the storeId of the AdminStore object to retrieve.

Returns:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getStoreDBById

public AdminStore getStoreDBById(java.lang.String storeId)
                          throws KKAdminException

Return the AdminStore object from the database with the specified storeId

Specified by:

getStoreDBById in interface AdminStoreMgrIf

Parameters:

storeId - the storeId of the AdminStore object to retrieve.

Returns:

an AdminStore object or null if the store isn't found

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteStoreDB

public void deleteStoreDB(java.lang.String storeId)
                   throws KKAdminException

Delete a Store from the Database

Specified by:

deleteStoreDB in interface AdminStoreMgrIf

Parameters:

storeId - A Store id

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

removeStoreDB

public void removeStoreDB(java.lang.String storeId)
                   throws KKAdminException

Delete a Store from the Database - this doesn't just mark the store as deleted (that's what deleteStoreDB does) but it removes all the records for this store from the database.

Specified by:

removeStoreDB in interface AdminStoreMgrIf

Parameters:

storeId - A Store id

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

doesStoreExistDB

public boolean doesStoreExistDB(java.lang.String storeId)
                         throws KKAdminException,
                                org.apache.torque.TorqueException

Return true if the store exists.

Specified by:

doesStoreExistDB in interface AdminStoreMgrIf

Parameters:

storeId - store id

Returns:

True if the zone exists

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertStore

public java.lang.String insertStore(AdminStore insertObj,
                                    int userId)
                             throws org.apache.torque.TorqueException,
                                    KKAdminException,
                                    java.lang.Exception

Insert an AdminStore object

Specified by:

insertStore in interface AdminStoreMgrIf

Parameters:

insertObj - An AdminStore object

userId - the user inserting the store

Returns:

returns the id of the inserted AdminStore object

Throws:

java.lang.Exception - an unexpected exception

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

cloneStore

public void cloneStore(AdminNewStoreOptions options,
                       java.lang.String storeToCloneId,
                       AdminStore newStore,
                       int userId)
                throws KKAdminException

Insert a new store into the mall by cloning a specified store. Multi-Store Single DB only

Specified by:

cloneStore in interface AdminStoreMgrIf

Parameters:

options - Some options for defining how to execute the clone

storeToCloneId - the store the will be cloned to make the new store

newStore - the new store

userId - the user inserting the store

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateStoreDB

public void updateStoreDB(AdminStore updateObj)
                   throws KKAdminException

Update an AdminStore object

Specified by:

updateStoreDB in interface AdminStoreMgrIf

Parameters:

updateObj - An AdminStore object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getNewCriteria

public com.konakart.db.KKCriteria getNewCriteria()

Gets a new KKCriteria object from the super class ten takes off the storeId as we never want to add a where storeId= constraint when looking up these stores.

Specified by:

getNewCriteria in interface AdminStoreMgrIf

Overrides:

getNewCriteria in class AdminBaseMgr

Returns:

Returns a new KKCriteria object