com.konakartadmin.bl

Class AdminHtmlMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminHtmlMgr

All Implemented Interfaces:

AdminHtmlMgrIf

public class AdminHtmlMgr
extends AdminBaseMgr
implements AdminHtmlMgrIf

The AdminHtmlMgr - for creating various HTML Strings for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminHtmlMgr.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
protected static java.util.Map<java.lang.String,AdminHtmlMgr.StaticData>	staticDataHM Hash Map that contains the static data

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

Method Summary

Modifier and Type	Method and Description
int	getDefaultLanguageId() Returns the default language id
java.lang.String	getHtml(int htmlType, int id, int languageId, java.lang.String arg1) Retrieve the html string for the specified html type.
java.lang.String	getHtml(int htmlType, int id, int languageId, java.lang.String templateName, java.lang.String arg1) Retrieve the html string for the specified html type.
protected java.lang.String	getHtmlOrder(int orderId, int languageId, java.lang.String orderTemplate)
protected java.lang.String	getHtmlOrder(int orderId, int languageId, java.lang.String orderTemplate, java.lang.String custom1)
protected java.lang.String	getHtmlOrderDetail(int orderId, int languageId)
protected java.lang.String	getHtmlOrderFromTemplate(int orderId, int languageId, java.lang.String templateName)
protected java.lang.String	getHtmlOrderFromTemplate(int orderId, int languageId, java.lang.String templateName, java.lang.String custom1)
protected java.lang.String	getHtmlOrderInvoice(int orderId, int languageId)
protected java.lang.String	getHtmlOrderPackingList(int orderId, int languageId)
org.apache.velocity.app.VelocityEngine	getVelocityEngine() Returns the Velocity engine
void	refreshConfigs() Retrieve some commonly-used properties and set the velocity log file location
void	sendOrderConfirmationEmail(java.lang.String sessionId, int orderId, java.lang.String mailSubject, int languageId) An order confirmation email is sent after submitting an order.
void	setDefaultLanguageId(int aDefaultLanguageId) Sets the default language id

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

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

AdminHtmlMgr

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

Constructor

Parameters:

eng - KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getHtml

public java.lang.String getHtml(int htmlType,
                                int id,
                                int languageId,
                                java.lang.String templateName,
                                java.lang.String arg1)
                         throws java.lang.Exception

Retrieve the html string for the specified html type. Typically used to get a section of formatted HTML that can be inserted into a page of some kind.

Specified by:

getHtml in interface AdminHtmlMgrIf

Parameters:

htmlType - the HTML type eg. KKConstants.HTML_ORDER_DETAIL

id - a record Id the use is dependent on the htmlType

languageId - the languageId for the language that the HTML should be in

templateName - the template name if the htmlType == KKConstants.HTML_NAMED_TEMPLATE

arg1 - an argument whose use is dependent on the htmlType

Returns:

a String of HTML

Throws:

java.lang.Exception - an unexpected exception

getHtml

public java.lang.String getHtml(int htmlType,
                                int id,
                                int languageId,
                                java.lang.String arg1)
                         throws java.lang.Exception

Retrieve the html string for the specified html type. Typically used to get a section of formatted HTML that can be inserted into a page of some kind.

Specified by:

getHtml in interface AdminHtmlMgrIf

Parameters:

htmlType - the HTML type eg. KonakartAdminConstants.HTML_ORDER_DETAIL

id - a record Id the use is dependent on the htmlType

languageId - the languageId for the language that the HTML should be in

arg1 - an argument whose use is dependent on the htmlType

Returns:

a String of HTML

Throws:

java.lang.Exception - an unexpected exception

getHtmlOrderFromTemplate

protected java.lang.String getHtmlOrderFromTemplate(int orderId,
                                                    int languageId,
                                                    java.lang.String templateName)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrderFromTemplate

protected java.lang.String getHtmlOrderFromTemplate(int orderId,
                                                    int languageId,
                                                    java.lang.String templateName,
                                                    java.lang.String custom1)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrderInvoice

protected java.lang.String getHtmlOrderInvoice(int orderId,
                                               int languageId)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrderPackingList

protected java.lang.String getHtmlOrderPackingList(int orderId,
                                                   int languageId)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrderDetail

protected java.lang.String getHtmlOrderDetail(int orderId,
                                              int languageId)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrder

protected java.lang.String getHtmlOrder(int orderId,
                                        int languageId,
                                        java.lang.String orderTemplate)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlOrder

protected java.lang.String getHtmlOrder(int orderId,
                                        int languageId,
                                        java.lang.String orderTemplate,
                                        java.lang.String custom1)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getVelocityEngine

public org.apache.velocity.app.VelocityEngine getVelocityEngine()
                                                         throws java.lang.Exception

Description copied from interface: AdminHtmlMgrIf

Returns the Velocity engine

Specified by:

getVelocityEngine in interface AdminHtmlMgrIf

Returns:

Returns a VelocityEngine

Throws:

java.lang.Exception - an unexpected exception

sendOrderConfirmationEmail

public void sendOrderConfirmationEmail(java.lang.String sessionId,
                                       int orderId,
                                       java.lang.String mailSubject,
                                       int languageId)
                                throws java.lang.Exception

An order confirmation email is sent after submitting an order.

Specified by:

sendOrderConfirmationEmail in interface AdminHtmlMgrIf

Parameters:

sessionId - the sessionId

orderId - the orderId

mailSubject - the mailSubject

languageId - the languageId

Throws:

java.lang.Exception - an unexpected exception

getDefaultLanguageId

public int getDefaultLanguageId()
                         throws java.lang.Exception

Description copied from interface: AdminHtmlMgrIf

Returns the default language id

Specified by:

getDefaultLanguageId in interface AdminHtmlMgrIf

Returns:

Returns the defaultLanguageId.

Throws:

java.lang.Exception - an unexpected exception

setDefaultLanguageId

public void setDefaultLanguageId(int aDefaultLanguageId)

Description copied from interface: AdminHtmlMgrIf

Sets the default language id

Specified by:

setDefaultLanguageId in interface AdminHtmlMgrIf

Parameters:

aDefaultLanguageId - The defaultLanguageId to set.

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Retrieve some commonly-used properties and set the velocity log file location

Specified by:

refreshConfigs in interface AdminHtmlMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception