com.konakartadmin.blif

Interface AdminHtmlMgrIf

All Known Implementing Classes:

AdminHtmlMgr

public interface AdminHtmlMgrIf

AdminHtmlMgrIf

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

Method Detail

getHtml

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.

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

getHtml

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.

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

getVelocityEngine

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

Returns the Velocity engine

Returns:

Returns a VelocityEngine

Throws:

java.lang.Exception - an unexpected exception

sendOrderConfirmationEmail

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.

Parameters:

sessionId - the sessionId

orderId - the orderId

mailSubject - the mailSubject

languageId - the languageId

Throws:

java.lang.Exception - an unexpected exception

getDefaultLanguageId

int getDefaultLanguageId()
                  throws java.lang.Exception

Returns the default language id

Returns:

Returns the defaultLanguageId.

Throws:

java.lang.Exception - an unexpected exception

setDefaultLanguageId

void setDefaultLanguageId(int aDefaultLanguageId)

Sets the default language id

Parameters:

aDefaultLanguageId - The defaultLanguageId to set.

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

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

Throws:

java.lang.Exception - an unexpected exception