com.konakart.bl

Class VelocityContextMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.VelocityContextMgr

All Implemented Interfaces:

VelocityContextMgrIf

public class VelocityContextMgr
extends BaseMgr
implements VelocityContextMgrIf

The VelocityContextMgr - for Managing context Maps

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Fields inherited from interface com.konakart.blif.VelocityContextMgrIf

ORDER_CONFIRMATION_EMAIL, SEND_NEW_PASSWORD, STOCK_REORDER_EMAIL, TEMPLATE_MAIL_TO_CUST, WELCOME_EMAIL

Constructor Summary

Constructors

Constructor and Description
VelocityContextMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addToContext(org.apache.velocity.VelocityContext context, KKEngIf eng, int contextType, int langId, EmailOptionsIf options, int customInt, java.lang.String customString) Put an object into the VelocityContext
protected java.lang.String	contextTypeToString(int contextType) Just for diagnostic purposes to translate the contextType integer into a human-readable String

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

log

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

the log

Constructor Detail

VelocityContextMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

addToContext

public void addToContext(org.apache.velocity.VelocityContext context,
                         KKEngIf eng,
                         int contextType,
                         int langId,
                         EmailOptionsIf options,
                         int customInt,
                         java.lang.String customString)
                  throws com.konakart.app.KKException

Description copied from interface: VelocityContextMgrIf

Put an object into the VelocityContext

Specified by:

addToContext in interface VelocityContextMgrIf

Parameters:

context - The velocity context

eng - engine

contextType - one of:

• VelocityContextMgrIf.ORDER_CONFIRMATION_EMAIL
• VelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST
• VelocityContextMgrIf.SEND_NEW_PASSWORD
• VelocityContextMgrIf.STOCK_REORDER_EMAIL
• VelocityContextMgrIf.WELCOME_EMAIL

langId - languageId

options - EmailOptions

customInt - a custom Integer - the meaning depends on the contextType:

• VelocityContextMgrIf.ORDER_CONFIRMATION_EMAIL - orderId
• VelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST - customerId
• VelocityContextMgrIf.SEND_NEW_PASSWORD - customerId
• VelocityContextMgrIf.STOCK_REORDER_EMAIL - productId
• VelocityContextMgrIf.WELCOME_EMAIL - customerId

customString - a custom String - the meaning depends on the contextType:

• VelocityContextMgrIf.ORDER_CONFIRMATION_EMAIL - customer's email address
• VelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST - message
• VelocityContextMgrIf.SEND_NEW_PASSWORD - customer's email address
• VelocityContextMgrIf.STOCK_REORDER_EMAIL - sku
• VelocityContextMgrIf.WELCOME_EMAIL - customer's email address

Throws:

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

contextTypeToString

protected java.lang.String contextTypeToString(int contextType)

Just for diagnostic purposes to translate the contextType integer into a human-readable String

Parameters:

contextType - the contextType

Returns:

a String representing the specified contextType