com.konakartadmin.bl

Class AdminFilterMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminFilterMgr

All Implemented Interfaces:

AdminFilterMgrIf

Direct Known Subclasses:

AdminFilterMgrEE

public class AdminFilterMgr
extends AdminBaseMgr
implements AdminFilterMgrIf

The AdminFilterMgr - for Managing Filter Objects for the Admin Application

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
protected static java.lang.String	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
AdminFilterMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	deleteFilter(int contentId) 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 contentId) Returns the filter 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 content) Insert an AdminFilter record.
void	refreshConfigs() Refresh the configuration of the Admin Base Manager
void	updateFilter(AdminFilter content) 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

log

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

the log

mutex

protected static java.lang.String mutex

Constructor Detail

AdminFilterMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

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

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

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

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

getFilter

public AdminFilter getFilter(int contentId)
                      throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Returns the filter referenced by the Id.

Specified by:

getFilter in interface AdminFilterMgrIf

Parameters:

contentId - the id of the Filter

Returns:

Returns an AdminFilter object if it exists, otherwise it returns null

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteFilter

public void deleteFilter(int contentId)
                  throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Delete an AdminFilter object

Specified by:

deleteFilter in interface AdminFilterMgrIf

Parameters:

contentId - 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

Parameters:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertFilter

public int insertFilter(AdminFilter content)
                 throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Insert an AdminFilter record.

Specified by:

insertFilter in interface AdminFilterMgrIf

Parameters:

content - 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 content)
                  throws KKAdminException

Description copied from interface: AdminFilterMgrIf

Update an AdminFilterType object

Specified by:

updateFilter in interface AdminFilterMgrIf

Parameters:

content - an AdminFilter object

Throws:

KKAdminException - an 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

Returns:

true if the filter manager is present otherwise false

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Description copied from class: AdminBaseMgr

Refresh the configuration of the Admin Base Manager

Specified by:

refreshConfigs in interface AdminFilterMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception