com.konakartadmin.bl

Class AdminFilterMgrEE

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminFilterMgr

com.konakartadmin.bl.AdminFilterMgrEE

All Implemented Interfaces:

AdminFilterMgrIf

public class AdminFilterMgrEE
extends AdminFilterMgr
implements AdminFilterMgrIf

The AdminFilterMgrEE - for Managing Filter Objects for the Admin Application

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	adminFilterMgrEEMutex
protected static java.util.Map<java.lang.String,AdminFilterMgrEE.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminFilterMgr

log, mutex

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

Method Summary

Modifier and Type	Method and Description
protected void	addFilterAttributes(com.konakart.db.KKCriteria c)
protected void	addFilterOrderBy(com.konakart.db.KKCriteria c, AdminDataDescriptor search)
protected int	addFilterSearchCriteria(com.konakart.db.KKCriteria c, AdminFilterSearch search)
protected int	addSearchCriteria(com.konakart.db.KKCriteria c, AdminDataDescriptor dataDesc)
protected void	checkFilter(AdminFilter filter)
void	deleteFilter(int id) Delete an AdminFilter object
void	deleteFiltersForCustomer(int userId) Delete all the AdminFilter objects associated with the specified customer
boolean	filterMgrPresent() Returns true if the filter manager is present.
AdminFilter	getFilter(int id) Returns the AdminFilter object referenced by the Id.
AdminFilterSearchResult	getFilters(AdminFilterSearch inSearch, AdminDataDescriptor dataDesc) Returns an array of filter records matching the search criteria.
AdminFilter[]	getFiltersForCustomer(int custId) Returns an array of filter records matching the search criteria.
int	insertFilter(AdminFilter filter) Insert an AdminFilter record.
void	refreshConfigs() Refresh the configuration of the Admin Filter Manager
void	removeCustomerFilters(int custId) Remove the filters of the specified customer from the cache
void	updateFilter(AdminFilter filter) Update an AdminFilterType 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, 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

adminFilterMgrEEMutex

protected static java.lang.String adminFilterMgrEEMutex

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

AdminFilterMgrEE

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getFiltersForCustomer

public AdminFilter[] getFiltersForCustomer(int custId)
                                    throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Returns an array of filter records matching the search criteria. If no records are found an empty array is returned.

Specified by:

getFiltersForCustomer in interface AdminFilterMgrIf

Overrides:

getFiltersForCustomer in class AdminFilterMgr

Parameters:

custId - an AdminFilterSearch object

Returns:

Returns the filters belonging to the specified customer. If there are no records an empty array is returned.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getFilters

public AdminFilterSearchResult getFilters(AdminFilterSearch inSearch,
                                          AdminDataDescriptor dataDesc)
                                   throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Returns an array of filter records matching the search criteria. If no records are found an empty array is returned.

Specified by:

getFilters in interface AdminFilterMgrIf

Overrides:

getFilters in class AdminFilterMgr

Parameters:

inSearch - an AdminFilterSearch object

dataDesc - an AdminDataDescriptor object

The returned filters may be sorted by:

• AdminDataDescriptor.ORDER_BY_ORDER_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_ORDER_ID_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOMERS_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOMERS_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_TABLE_ASCENDING
• AdminDataDescriptor.ORDER_BY_TABLE_DESCENDING
• AdminDataDescriptor.ORDER_BY_COLUMN_ASCENDING
• AdminDataDescriptor.ORDER_BY_COLUMN_DESCENDING
• AdminDataDescriptor.ORDER_BY_CONSTRAINT_ASCENDING
• AdminDataDescriptor.ORDER_BY_CONSTRAINT_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM1_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM1_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM2_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM3_DESCENDING

Returns:

Returns an AdminFilterSearchResult object containing an array of filter records matching the search criteria. If there are no records an empty array is returned within the AdminFilterSearchResult.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getFilter

public AdminFilter getFilter(int id)
                      throws KKAdminException

Returns the AdminFilter object referenced by the Id.

Specified by:

getFilter in interface AdminFilterMgrIf

Overrides:

getFilter in class AdminFilterMgr

Parameters:

id - the id

Returns:

Returns a filter

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertFilter

public int insertFilter(AdminFilter filter)
                 throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Insert an AdminFilter record.

Specified by:

insertFilter in interface AdminFilterMgrIf

Overrides:

insertFilter in class AdminFilterMgr

Parameters:

filter - the AdminFilter record to insert

Returns:

the Id of the inserted AdminFilter

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateFilter

public void updateFilter(AdminFilter filter)
                  throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Update an AdminFilterType object

Specified by:

updateFilter in interface AdminFilterMgrIf

Overrides:

updateFilter in class AdminFilterMgr

Parameters:

filter - an AdminFilter object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteFilter

public void deleteFilter(int id)
                  throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Delete an AdminFilter object

Specified by:

deleteFilter in interface AdminFilterMgrIf

Overrides:

deleteFilter in class AdminFilterMgr

Parameters:

id - the Id of the AdminFilter record to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteFiltersForCustomer

public void deleteFiltersForCustomer(int userId)
                              throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Delete all the AdminFilter objects associated with the specified customer

Specified by:

deleteFiltersForCustomer in interface AdminFilterMgrIf

Overrides:

deleteFiltersForCustomer in class AdminFilterMgr

Parameters:

userId - the userId of the customer whose AdminFilter records to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addFilterAttributes

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

addSearchCriteria

protected int addSearchCriteria(com.konakart.db.KKCriteria c,
                                AdminDataDescriptor dataDesc)

addFilterSearchCriteria

protected int addFilterSearchCriteria(com.konakart.db.KKCriteria c,
                                      AdminFilterSearch search)
                               throws KKAdminException

Throws:

KKAdminException

addFilterOrderBy

protected void addFilterOrderBy(com.konakart.db.KKCriteria c,
                                AdminDataDescriptor search)

checkFilter

protected void checkFilter(AdminFilter filter)
                    throws KKAdminException

Throws:

KKAdminException

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Filter Manager

Specified by:

refreshConfigs in interface AdminFilterMgrIf

Overrides:

refreshConfigs in class AdminFilterMgr

Throws:

java.lang.Exception - an unexpected exception

removeCustomerFilters

public void removeCustomerFilters(int custId)
                           throws KKAdminException

Remove the filters of the specified customer from the cache

Parameters:

custId - the custId

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

filterMgrPresent

public boolean filterMgrPresent()

Description copied from interface: AdminFilterMgrIf

Returns true if the filter manager is present. Only the EE version will return true.

Specified by:

filterMgrPresent in interface AdminFilterMgrIf

Overrides:

filterMgrPresent in class AdminFilterMgr

Returns:

true if the filter manager is present otherwise false