com.konakartadmin.bl

Class AdminVelocityContextMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminVelocityContextMgr

All Implemented Interfaces:

AdminVelocityContextMgrIf

public class AdminVelocityContextMgr
extends AdminBaseMgr
implements AdminVelocityContextMgrIf

The AdminVelocityContextMgr - for Managing context Maps

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

Fields inherited from interface com.konakartadmin.blif.AdminVelocityContextMgrIf

ORDER_DETAIL, ORDER_INVOICE, ORDER_NAMED_TEMPLATE, ORDER_PACKING_LIST, SEND_NEW_PASSWORD, STATUS_CHANGE_EMAIL, TEMPLATE_MAIL_TO_CUST

Constructor Summary

Constructors

Constructor and Description
AdminVelocityContextMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addToContext(org.apache.velocity.VelocityContext context, KKAdminIf eng, int contextType, int langId, AdminEmailOptions options, int customInt, java.lang.String customString) Put an object into the VelocityContext
protected java.lang.String	contextTypeToString(int contextType)

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

AdminVelocityContextMgr

public AdminVelocityContextMgr(KKAdminIf 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,
                         KKAdminIf eng,
                         int contextType,
                         int langId,
                         AdminEmailOptions options,
                         int customInt,
                         java.lang.String customString)
                  throws KKAdminException

Description copied from interface: AdminVelocityContextMgrIf

Put an object into the VelocityContext

Specified by:

addToContext in interface AdminVelocityContextMgrIf

Parameters:

context - The velocity context

eng - engine

contextType - one of:

• AdminVelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST
• AdminVelocityContextMgrIf.SEND_NEW_PASSWORD
• AdminVelocityContextMgrIf.STATUS_CHANGE_EMAIL
• AdminVelocityContextMgrIf.ORDER_INVOICE
• AdminVelocityContextMgrIf.ORDER_DETAIL
• AdminVelocityContextMgrIf.ORDER_PACKING_LIST
• AdminVelocityContextMgrIf.ORDER_NAMED_TEMPLATE

langId - languageId

options - EmailOptions

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

• AdminVelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST - customerId
• AdminVelocityContextMgrIf.SEND_NEW_PASSWORD - not set
• AdminVelocityContextMgrIf.STATUS_CHANGE_EMAIL - orderId
• AdminVelocityContextMgrIf.ORDER_INVOICE - orderId
• AdminVelocityContextMgrIf.ORDER_DETAIL - orderId
• AdminVelocityContextMgrIf.ORDER_PACKING_LIST - orderId
• AdminVelocityContextMgrIf.ORDER_NAMED_TEMPLATE - orderId

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

• AdminVelocityContextMgrIf.TEMPLATE_MAIL_TO_CUST - template name
• AdminVelocityContextMgrIf.SEND_NEW_PASSWORD - customer's email address
• AdminVelocityContextMgrIf.STATUS_CHANGE_EMAIL - new state Id

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

contextTypeToString

protected java.lang.String contextTypeToString(int contextType)