com.konakartadmin.bl

Class AdminCustomerTagMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminCustomerTagMgr

All Implemented Interfaces:

AdminCustomerTagMgrIf

Direct Known Subclasses:

AdminCustomerTagMgrEE

public class AdminCustomerTagMgr
extends AdminBaseMgr
implements AdminCustomerTagMgrIf

The AdminCustomerTagMgr - for managing customer tags

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

Method Summary

Modifier and Type	Method and Description
protected void	addCustomerTagOrderBy(com.konakart.db.KKCriteria c, AdminCustomerTagSearch search) Add order by constraints for customer tags
protected int	addCustomerTagSearchCriteria(com.konakart.db.KKCriteria c, AdminCustomerTagSearch search) Add search criteria for customer tags
protected void	addExpressionOrderBy(com.konakart.db.KKCriteria c, AdminExpressionSearch search)
protected int	addExpressionSearchCriteria(com.konakart.db.KKCriteria c, AdminExpressionSearch search)
int	deleteCustomerTag(int id) Delete a Customer tag
void	deleteCustomerTagForCustomer(int customerId, java.lang.String tagName) Deletes the value of the customer tag referenced by tagName for the customer referenced by customerId.
int	deleteExpression(int id) Deletes the Expression object referenced by id.
int	deleteExpressionVariable(int id) Deletes the ExpressionVariable object referenced by id.
void	deleteExpressionVariablesForExpression(int expressionId) Deletes all of the AdminExpressionVariable objects belonging to the AdminExpression referenced by expressionId.
boolean	evaluateExpression(int customerId, int expressionId, java.lang.String expressionName) An expression object is retrieved from the database and evaluated for the customer referenced by the customerId.
AdminCustomerTag	getCustomerTag(int id) Returns the customer tag object for the id parameter, or Null if the customer tag doesn't exist in the DB.
protected int	getCustomerTagCount(AdminCustomerTagSearch search) Returns a count of the number of CustomerTags
AdminCustomerTag	getCustomerTagForCustomer(int customerId, java.lang.String tagName) Returns the customer tag object for the tagName parameter, or Null if the customer tag doesn't exist in the DB.
AdminCustomerTag	getCustomerTagForName(java.lang.String tagName) Returns the customer tag object for the tagName parameter, or Null if the customer tag doesn't exist in the DB.
AdminCustomerTagSearchResult	getCustomerTags(AdminCustomerTagSearch search, int offset, int size) This returns an AdminCustomerTagSearchResult object.
AdminCustomerTag[]	getCustomerTagsForCustomer(int customerId) This method fetches all of the customer tags for the customer referenced by the customerId parameter.
AdminCustomerTag[]	getCustomerTagsForCustomer(int customerId, java.lang.String[] tagNames) Returns the customer tag objects for the tagNames parameter, or Null if none of the specified customer tags exist in the DB for the customer.
AdminExpression	getExpression(int id) Returns the AdminExpression object for the id parameter, or Null if the AdminExpression doesn't exist in the DB.
int	getExpressionCount(AdminExpressionSearch search) Returns the number of expressions available for the given search
protected AdminExpression	getExpressionForCustomer(int custId, int expressionId, java.lang.String expressionName) An AdminExpression object, fully populated with an array of Expression Variables is returned.
AdminExpression	getExpressionForName(java.lang.String expName) Returns the AdminExpression object for the expName parameter, or Null if the AdminExpression doesn't exist in the DB.
AdminExpressionSearchResult	getExpressions(AdminExpressionSearch search, int offset, int size) This returns an AdminExpressionSearchResult object.
AdminExpression[]	getExpressionsPerPromotion(int promotionId) Fetch an array of Expression objects linked to the promotion referenced by promotionId
AdminExpressionVariable	getExpressionVariable(int id) Returns the AdminExpressionVariable object for the id parameter, or Null if the AdminExpressionVariable doesn't exist in the DB.
protected int	getExpressionVariableCount(int expressionId)
AdminExpressionVariable[]	getExpressionVariablesForExpression(int expressionId) Returns an array of AdminExpressionVariable objects for the AdminExpression identified by the id parameter.
int	insertCustomerTag(AdminCustomerTag tag) An AdminCustomerTag object is inserted into the database.
void	insertCustomerTagForCustomer(int customerId, AdminCustomerTag tag) Assigns a customer tag to the customer referenced by the customerId.
int	insertExpression(AdminExpression exp) Inserts an AdminExpression object.
int	insertExpressionVariables(AdminExpressionVariable[] expVarArray) Inserts an array of ExpressionVariable objects that should all belong to the same expression.
protected void	setExpressionCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Common code to avoid duplication which sets up the standard attributes for Expressions on the criteria object.
protected void	setExpressionVariableCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c, int customerId) Common code to avoid duplication which sets up the standard attributes for Expression Variables on the criteria object
protected void	setTagCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c, int customerId) Common code to avoid duplication
int	updateCustomerTag(AdminCustomerTag tag) Update an AdminCustomerTag object.
int	updateExpression(AdminExpression exp) Updates the expression.
int	updateExpressionVariable(AdminExpressionVariable expVar) Updates the ExpressionVariable object passed in as a parameter.
protected int	updateExpressionVariableCount(int expressionId) Returns the number of expression variable objects for the expression
protected void	updateNumVariables(int ExpressionId, int numVariables) Update the number of variables attribute for the Expression
protected void	validateExpressionVariable(AdminExpressionVariable expVar, java.util.HashMap<java.lang.Integer,java.lang.String> custHM, java.util.HashMap<java.lang.Integer,java.lang.String> expHM, com.konakart.db.KKCriteria c)

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

Field Detail

log

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

the log

Constructor Detail

AdminCustomerTagMgr

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

Constructor

Parameters:

eng - the Admin Engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

insertCustomerTag

public int insertCustomerTag(AdminCustomerTag tag)
                      throws KKAdminException,
                             org.apache.torque.TorqueException

An AdminCustomerTag object is inserted into the database. The following customer tag attributes are compulsory:

• name
• description
• type

The id of the new object is returned.

Specified by:

insertCustomerTag in interface AdminCustomerTagMgrIf

Parameters:

tag - the tag

Returns:

Returns the id of the CustomerTag object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertCustomerTagForCustomer

public void insertCustomerTagForCustomer(int customerId,
                                         AdminCustomerTag tag)
                                  throws KKAdminException,
                                         org.apache.torque.TorqueException,
                                         java.text.ParseException,
                                         com.workingdogs.village.DataSetException

Assigns a customer tag to the customer referenced by the customerId. If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:

• name
• value

Note that a customer tag with name tag.getName() must exist in the database since it is used to validate tag.getValue().

Specified by:

insertCustomerTagForCustomer in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

tag - the tag

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

java.text.ParseException - an unexpected ParseException exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

updateCustomerTag

public int updateCustomerTag(AdminCustomerTag tag)
                      throws KKAdminException,
                             org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException

Update an AdminCustomerTag object. If the value of an attribute is null, the current value is not updated.

Specified by:

updateCustomerTag in interface AdminCustomerTagMgrIf

Parameters:

tag - An AdminCustomerTag object

Returns:

returns the id of the updated AdminCustomerTag object

Throws:

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

deleteCustomerTag

public int deleteCustomerTag(int id)
                      throws KKAdminException,
                             org.apache.torque.TorqueException

Delete a Customer tag

Specified by:

deleteCustomerTag in interface AdminCustomerTagMgrIf

Parameters:

id - The id of the deleted customer tag

Returns:

Returns the id of the deleted customer tag

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteCustomerTagForCustomer

public void deleteCustomerTagForCustomer(int customerId,
                                         java.lang.String tagName)
                                  throws KKAdminException,
                                         org.apache.torque.TorqueException

Deletes the value of the customer tag referenced by tagName for the customer referenced by customerId.

Specified by:

deleteCustomerTagForCustomer in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

tagName - the tagName

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getCustomerTag

public AdminCustomerTag getCustomerTag(int id)
                                throws KKAdminException,
                                       org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException

Returns the customer tag object for the id parameter, or Null if the customer tag doesn't exist in the DB.

Specified by:

getCustomerTag in interface AdminCustomerTagMgrIf

Parameters:

id - the id

Returns:

Returns a customer tag object

Throws:

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

getCustomerTagForName

public AdminCustomerTag getCustomerTagForName(java.lang.String tagName)
                                       throws KKAdminException,
                                              org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException

Returns the customer tag object for the tagName parameter, or Null if the customer tag doesn't exist in the DB.

Specified by:

getCustomerTagForName in interface AdminCustomerTagMgrIf

Parameters:

tagName - the tagName

Returns:

Returns a customer tag object

Throws:

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

getCustomerTagForCustomer

public AdminCustomerTag getCustomerTagForCustomer(int customerId,
                                                  java.lang.String tagName)
                                           throws KKAdminException,
                                                  org.apache.torque.TorqueException,
                                                  com.workingdogs.village.DataSetException

Returns the customer tag object for the tagName parameter, or Null if the customer tag doesn't exist in the DB. The value attribute of the customer tag contains the value for the customer referenced by customerId.

Specified by:

getCustomerTagForCustomer in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

tagName - the tagName

Returns:

Returns a customer tag object

Throws:

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

getCustomerTagsForCustomer

public AdminCustomerTag[] getCustomerTagsForCustomer(int customerId,
                                                     java.lang.String[] tagNames)
                                              throws KKAdminException,
                                                     org.apache.torque.TorqueException,
                                                     com.workingdogs.village.DataSetException

Returns the customer tag objects for the tagNames parameter, or Null if none of the specified customer tags exist in the DB for the customer. The value attribute of the customer tag contains the value for the customer referenced by customerId.

Specified by:

getCustomerTagsForCustomer in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

tagNames - the tagNames to retrieve

Returns:

Returns an array of customer tag objects or null if none are found

Throws:

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

getCustomerTagsForCustomer

public AdminCustomerTag[] getCustomerTagsForCustomer(int customerId)
                                              throws org.apache.torque.TorqueException,
                                                     KKAdminException,
                                                     com.workingdogs.village.DataSetException

This method fetches all of the customer tags for the customer referenced by the customerId parameter. The value attribute of the customer tag contains the value for the customer referenced by customerId.

An empty array is returned if no tags exist.

Specified by:

getCustomerTagsForCustomer in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

Returns:

Returns an array of AdminCustomerTag objects

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getCustomerTags

public AdminCustomerTagSearchResult getCustomerTags(AdminCustomerTagSearch search,
                                                    int offset,
                                                    int size)
                                             throws org.apache.torque.TorqueException,
                                                    com.workingdogs.village.DataSetException,
                                                    KKAdminException

This returns an AdminCustomerTagSearchResult object.

Specified by:

getCustomerTags in interface AdminCustomerTagMgrIf

Parameters:

search - the search

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminCustomerTagSearchResult object

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

addCustomerTagOrderBy

protected void addCustomerTagOrderBy(com.konakart.db.KKCriteria c,
                                     AdminCustomerTagSearch search)

Add order by constraints for customer tags

Parameters:

c - the c

search - the search

getCustomerTagCount

protected int getCustomerTagCount(AdminCustomerTagSearch search)
                           throws org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException,
                                  KKAdminException

Returns a count of the number of CustomerTags

Parameters:

search - Search criteria

Returns:

A count of the number of CustomerTags

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

addCustomerTagSearchCriteria

protected int addCustomerTagSearchCriteria(com.konakart.db.KKCriteria c,
                                           AdminCustomerTagSearch search)

Add search criteria for customer tags

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

setTagCriteriaWithStandardAttributes

protected void setTagCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c,
                                                    int customerId)

Common code to avoid duplication

Parameters:

c - the c

customerId - the customerId

insertExpression

public int insertExpression(AdminExpression exp)
                     throws KKAdminException,
                            org.apache.torque.TorqueException

Inserts an AdminExpression object. Only the name attribute of the AdminExpression is required.

Specified by:

insertExpression in interface AdminCustomerTagMgrIf

Parameters:

exp - The AdminExpression object to be inserted

Returns:

Returns the id of the inserted object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updateExpression

public int updateExpression(AdminExpression exp)
                     throws KKAdminException,
                            org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException

Updates the expression. An exception is thrown if the AdminExpression does not exist.

Specified by:

updateExpression in interface AdminCustomerTagMgrIf

Parameters:

exp - The AdminExpression object to be updated

Returns:

Returns the id of the updated AdminExpression object

Throws:

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

updateExpressionVariableCount

protected int updateExpressionVariableCount(int expressionId)
                                     throws KKAdminException,
                                            org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Returns the number of expression variable objects for the expression

Parameters:

expressionId - the expressionId

Returns:

Returns the number of expression variable objects for the expression

Throws:

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

deleteExpression

public int deleteExpression(int id)
                     throws java.lang.Exception

Deletes the Expression object referenced by id.

Specified by:

deleteExpression in interface AdminCustomerTagMgrIf

Parameters:

id - The id of the AdminExpression object to be deleted

Returns:

Returns the id of the AdminExpression object deleted

Throws:

java.lang.Exception - an unexpected exception

getExpression

public AdminExpression getExpression(int id)
                              throws KKAdminException,
                                     org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException

Returns the AdminExpression object for the id parameter, or Null if the AdminExpression doesn't exist in the DB.

Specified by:

getExpression in interface AdminCustomerTagMgrIf

Parameters:

id - The id of the AdminExpression object

Returns:

Returns an AdminExpression object

Throws:

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

updateNumVariables

protected void updateNumVariables(int ExpressionId,
                                  int numVariables)
                           throws org.apache.torque.TorqueException,
                                  KKAdminException

Update the number of variables attribute for the Expression

Parameters:

ExpressionId - the ExpressionId

numVariables - the numVariables

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

evaluateExpression

public boolean evaluateExpression(int customerId,
                                  int expressionId,
                                  java.lang.String expressionName)
                           throws java.lang.Exception

An expression object is retrieved from the database and evaluated for the customer referenced by the customerId. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter.

Specified by:

evaluateExpression in interface AdminCustomerTagMgrIf

Parameters:

customerId - the customerId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns true or false

Throws:

java.lang.Exception - an unexpected exception

getExpressionForCustomer

protected AdminExpression getExpressionForCustomer(int custId,
                                                   int expressionId,
                                                   java.lang.String expressionName)
                                            throws java.lang.Exception

An AdminExpression object, fully populated with an array of Expression Variables is returned. If the expressionName parameter is not set to null, then the Expression is searched for by name. Otherwise it is searched for by the id contained in the expressionId parameter. The expression variables will be populated with the customer tag values for the customer referenced by custId. other

Parameters:

custId - the custId

expressionId - the expressionId

expressionName - the expressionName

Returns:

Returns a fully populated AdminExpression object

Throws:

java.lang.Exception - an unexpected exception

getExpressionVariable

public AdminExpressionVariable getExpressionVariable(int id)
                                              throws KKAdminException,
                                                     org.apache.torque.TorqueException,
                                                     com.workingdogs.village.DataSetException

Returns the AdminExpressionVariable object for the id parameter, or Null if the AdminExpressionVariable doesn't exist in the DB.

Specified by:

getExpressionVariable in interface AdminCustomerTagMgrIf

Parameters:

id - The id of the AdminExpressionVariable object

Returns:

Returns an AdminExpressionVariable object

Throws:

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

getExpressionVariablesForExpression

public AdminExpressionVariable[] getExpressionVariablesForExpression(int expressionId)
                                                              throws KKAdminException,
                                                                     org.apache.torque.TorqueException,
                                                                     com.workingdogs.village.DataSetException

Returns an array of AdminExpressionVariable objects for the AdminExpression identified by the id parameter. An empty array is returned if no objects are found.

Specified by:

getExpressionVariablesForExpression in interface AdminCustomerTagMgrIf

Parameters:

expressionId - The AdminExpression id for the AdminExpressionVariable objects

Returns:

Returns an array of AdminExpression objects

Throws:

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

getExpressionForName

public AdminExpression getExpressionForName(java.lang.String expName)
                                     throws KKAdminException,
                                            org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Returns the AdminExpression object for the expName parameter, or Null if the AdminExpression doesn't exist in the DB.

Specified by:

getExpressionForName in interface AdminCustomerTagMgrIf

Parameters:

expName - The name of the AdminExpression object

Returns:

Returns Returns an AdminExpression object or Null if the AdminExpression with the specified name doesn't exist in the DB.

Throws:

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

getExpressionsPerPromotion

public AdminExpression[] getExpressionsPerPromotion(int promotionId)
                                             throws com.workingdogs.village.DataSetException,
                                                    org.apache.torque.TorqueException,
                                                    KKAdminException

Fetch an array of Expression objects linked to the promotion referenced by promotionId

Specified by:

getExpressionsPerPromotion in interface AdminCustomerTagMgrIf

Parameters:

promotionId - the promotionId

Returns:

An array of all manufacturers relevant to a promotion

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

getExpressions

public AdminExpressionSearchResult getExpressions(AdminExpressionSearch search,
                                                  int offset,
                                                  int size)
                                           throws org.apache.torque.TorqueException,
                                                  com.workingdogs.village.DataSetException,
                                                  KKAdminException

This returns an AdminExpressionSearchResult object. Constraints may be added for:

• id
• name

The returned objects may be ordered by:

• AdminDataDescriptor.ORDER_BY_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_ID_DESCENDING
• AdminDataDescriptor.ORDER_BY_NAME_ASCENDING
• AdminDataDescriptor.ORDER_BY_NAME_DESCENDING

Specified by:

getExpressions in interface AdminCustomerTagMgrIf

Parameters:

search - The search object that defines the search parameters and sort order

offset - The offset in the db

size - The number of records from the specified offset

Returns:

Returns an AdminExpressionSearchResult 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 - an unexpected exception in the KonaKart Admin engine

getExpressionCount

public int getExpressionCount(AdminExpressionSearch search)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              KKAdminException

Description copied from interface: AdminCustomerTagMgrIf

Returns the number of expressions available for the given search

Specified by:

getExpressionCount in interface AdminCustomerTagMgrIf

Parameters:

search - the search

Returns:

Returns the number of expressions found

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

getExpressionVariableCount

protected int getExpressionVariableCount(int expressionId)
                                  throws org.apache.torque.TorqueException,
                                         com.workingdogs.village.DataSetException,
                                         KKAdminException

Parameters:

expressionId - the expressionId

Returns:

Returns the number of expression variables found

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

addExpressionSearchCriteria

protected int addExpressionSearchCriteria(com.konakart.db.KKCriteria c,
                                          AdminExpressionSearch search)
                                   throws KKAdminException

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addExpressionOrderBy

protected void addExpressionOrderBy(com.konakart.db.KKCriteria c,
                                    AdminExpressionSearch search)
                             throws KKAdminException

Parameters:

c - the c

search - the search

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertExpressionVariables

public int insertExpressionVariables(AdminExpressionVariable[] expVarArray)
                              throws KKAdminException,
                                     org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException

Inserts an array of ExpressionVariable objects that should all belong to the same expression. If the array only contains one Expression Variable then, the id of that variable is returned. Otherwise the return value is set to 0.

Specified by:

insertExpressionVariables in interface AdminCustomerTagMgrIf

Parameters:

expVarArray - The AdminExpressionVariable array of objects to be inserted

Returns:

If the array only contains one Expression Variable then, the id of that variable is returned. Otherwise the return value is set to 0.

Throws:

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

updateExpressionVariable

public int updateExpressionVariable(AdminExpressionVariable expVar)
                             throws KKAdminException,
                                    org.apache.torque.TorqueException

Updates the ExpressionVariable object passed in as a parameter. An exception is thrown if it does not exist.

Specified by:

updateExpressionVariable in interface AdminCustomerTagMgrIf

Parameters:

expVar - The AdminExpressionVariable object to be updated

Returns:

Returns the id of the updated AdminExpression object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

validateExpressionVariable

protected void validateExpressionVariable(AdminExpressionVariable expVar,
                                          java.util.HashMap<java.lang.Integer,java.lang.String> custHM,
                                          java.util.HashMap<java.lang.Integer,java.lang.String> expHM,
                                          com.konakart.db.KKCriteria c)
                                   throws KKAdminException,
                                          org.apache.torque.TorqueException

Parameters:

expVar - the expVar

custHM - the custHM

expHM - the expHM

c - the c

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteExpressionVariable

public int deleteExpressionVariable(int id)
                             throws org.apache.torque.TorqueException,
                                    KKAdminException,
                                    com.workingdogs.village.DataSetException

Deletes the ExpressionVariable object referenced by id.

Specified by:

deleteExpressionVariable in interface AdminCustomerTagMgrIf

Parameters:

id - The id of the AdminExpressionVariable object to be deleted

Returns:

Returns the id of the AdminExpression object deleted

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteExpressionVariablesForExpression

public void deleteExpressionVariablesForExpression(int expressionId)
                                            throws org.apache.torque.TorqueException,
                                                   KKAdminException,
                                                   com.workingdogs.village.DataSetException

Deletes all of the AdminExpressionVariable objects belonging to the AdminExpression referenced by expressionId.

Specified by:

deleteExpressionVariablesForExpression in interface AdminCustomerTagMgrIf

Parameters:

expressionId - The id of the AdminExpression object

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

setExpressionCriteriaWithStandardAttributes

protected void setExpressionCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)
                                                    throws KKAdminException

Common code to avoid duplication which sets up the standard attributes for Expressions on the criteria object.

Parameters:

c - criteria object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

setExpressionVariableCriteriaWithStandardAttributes

protected void setExpressionVariableCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c,
                                                                   int customerId)
                                                            throws KKAdminException

Common code to avoid duplication which sets up the standard attributes for Expression Variables on the criteria object

Parameters:

c - criteria object

customerId - customer Id

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine