Package de.hybris.platform.warehousing.labels.context

Class CommonReturnDocumentContext

java.lang.Object

org.apache.velocity.context.AbstractContext

org.apache.velocity.VelocityContext

de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext<BusinessProcessModel>

de.hybris.platform.warehousing.labels.context.CommonReturnDocumentContext

All Implemented Interfaces:

java.lang.Cloneable, org.apache.velocity.context.Context, org.apache.velocity.context.InternalEventContext

Direct Known Subclasses:

ReturnFormContext, ReturnShippingLabelContext

public class CommonReturnDocumentContext
extends AbstractDocumentContext<BusinessProcessModel>

Common context for velocity templates related to return form attached to either ConsignmentModel or ReturnRequestModel

Field Summary

Fields inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext

DOCUMENT_LANGUAGE

Fields inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

BASE_SITE, BASE_THEME_URL, BASE_URL, MEDIA_BASE_URL, MEDIA_SECURE_BASE_URL, SECURE_BASE_URL, THEME

Constructor Summary

Constructors

Constructor	Description
CommonReturnDocumentContext()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.event.EventCartridge	attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0)
java.lang.String	escapeHtml(java.lang.String stringToEscape)	Escapes String to generate safe HTML
AddressModel	getAddress()
int	getCurrentMacroCallDepth()
java.lang.String	getCurrentMacroName()
org.apache.velocity.runtime.resource.Resource	getCurrentResource()
java.lang.String	getCurrentTemplateName()
org.apache.velocity.tools.generic.DateTool	getDate()
protected LanguageModel	getDocumentLanguage(BusinessProcessModel businessProcessModel)
org.apache.velocity.app.event.EventCartridge	getEventCartridge()
java.util.List	getMacroLibraries()
java.lang.Object[]	getMacroNameStack()
AbstractOrderModel	getOrder()
protected AbstractOrderModel	getOrder(BusinessProcessModel businessProcessModel)	Get AbstractOrderModel from given BusinessProcessModel
protected AddressModel	getPosAddress(AbstractOrderModel order, WarehouseModel returnWarehouse)	Extracts the AddressModel where the returned goods need to be shipped by the customer
protected PosSelectionStrategy	getPosSelectionStrategy()
protected BaseSiteModel	getSite(BusinessProcessModel businessProcessModel)
java.lang.Object[]	getTemplateNameStack()
org.apache.velocity.util.introspection.IntrospectionCacheData	icacheGet(java.lang.Object arg0)
void	icachePut(java.lang.Object arg0, org.apache.velocity.util.introspection.IntrospectionCacheData arg1)
void	init(BusinessProcessModel businessProcessModel, DocumentPageModel documentPageModel)
void	popCurrentMacroName()
void	popCurrentTemplateName()
void	pushCurrentMacroName(java.lang.String arg0)
void	pushCurrentTemplateName(java.lang.String arg0)
void	setAddress(AddressModel address)
void	setCurrentResource(org.apache.velocity.runtime.resource.Resource arg0)
void	setDate(org.apache.velocity.tools.generic.DateTool date)
void	setMacroLibraries(java.util.List arg0)
void	setOrder(AbstractOrderModel order)
void	setPosSelectionStrategy(PosSelectionStrategy posSelectionStrategy)
protected void	validateProcessType(BusinessProcessModel businessProcessModel)	Validates that given BusinessProcessModel is either instance of ConsignmentProcessModel or ReturnProcessModel

Methods inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext

getDocumentLanguage

Methods inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

getBaseSite, getBaseThemeUrl, getBaseUrl, getCmsSlotContents, getMediaBaseUrl, getMediaSecureBaseUrl, getMessage, getMessages, getSecureBaseUrl, getSiteBaseUrlResolutionService, getTheme, getUrlEncoderService, getUrlEncodingAttributes, init, setBaseSite, setCmsSlotContents, setMessages, setSiteBaseUrlResolutionService, setUrlEncoderService, setUrlEncodingAttributes

Methods inherited from class org.apache.velocity.VelocityContext

clone, internalContainsKey, internalGet, internalGetKeys, internalPut, internalRemove

Methods inherited from class org.apache.velocity.context.AbstractContext

containsKey, get, getChainedContext, getKeys, put, remove

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommonReturnDocumentContext

public CommonReturnDocumentContext()

Method Detail

init

public void init(BusinessProcessModel businessProcessModel,
                 DocumentPageModel documentPageModel)

Overrides:

init in class AbstractDocumentContext<BusinessProcessModel>

escapeHtml

public java.lang.String escapeHtml(java.lang.String stringToEscape)

Escapes String to generate safe HTML

Parameters:

stringToEscape - String to escape

Returns:

escaped String

getPosAddress

protected AddressModel getPosAddress(AbstractOrderModel order,
                                     WarehouseModel returnWarehouse)

Extracts the AddressModel where the returned goods need to be shipped by the customer

Parameters:

order - the AbstractOrderModel for which address needs to be calculated

returnWarehouse - the WarehouseModel for which address needs to be extracted

Returns:

the AddressModel of PointOfServiceModel

getOrder

protected AbstractOrderModel getOrder(BusinessProcessModel businessProcessModel)

Get AbstractOrderModel from given BusinessProcessModel

Parameters:

businessProcessModel - the BusinessProcessModel, for which AbstractOrderModel needs be retrieved

Returns:

AbstractOrderModel assigned to given BusinessProcessModel

getSite

protected BaseSiteModel getSite(BusinessProcessModel businessProcessModel)

Specified by:

getSite in class AbstractDocumentContext<BusinessProcessModel>

getDocumentLanguage

protected LanguageModel getDocumentLanguage(BusinessProcessModel businessProcessModel)

Specified by:

getDocumentLanguage in class AbstractDocumentContext<BusinessProcessModel>

validateProcessType

protected void validateProcessType(BusinessProcessModel businessProcessModel)

Validates that given BusinessProcessModel is either instance of ConsignmentProcessModel or ReturnProcessModel

Parameters:

businessProcessModel - the BusinessProcessModel to be validated

setDate

public void setDate(org.apache.velocity.tools.generic.DateTool date)

setOrder

public void setOrder(AbstractOrderModel order)

setAddress

public void setAddress(AddressModel address)

getOrder

public AbstractOrderModel getOrder()

getDate

public org.apache.velocity.tools.generic.DateTool getDate()

getAddress

public AddressModel getAddress()

getPosSelectionStrategy

protected PosSelectionStrategy getPosSelectionStrategy()

setPosSelectionStrategy

public void setPosSelectionStrategy(PosSelectionStrategy posSelectionStrategy)

pushCurrentTemplateName

public void pushCurrentTemplateName(java.lang.String arg0)

popCurrentTemplateName

public void popCurrentTemplateName()

getCurrentTemplateName

public java.lang.String getCurrentTemplateName()

getTemplateNameStack

public java.lang.Object[] getTemplateNameStack()

pushCurrentMacroName

public void pushCurrentMacroName(java.lang.String arg0)

popCurrentMacroName

public void popCurrentMacroName()

getCurrentMacroName

public java.lang.String getCurrentMacroName()

getCurrentMacroCallDepth

public int getCurrentMacroCallDepth()

getMacroNameStack

public java.lang.Object[] getMacroNameStack()

icacheGet

public org.apache.velocity.util.introspection.IntrospectionCacheData icacheGet(java.lang.Object arg0)

icachePut

public void icachePut(java.lang.Object arg0,
                      org.apache.velocity.util.introspection.IntrospectionCacheData arg1)

setCurrentResource

public void setCurrentResource(org.apache.velocity.runtime.resource.Resource arg0)

getCurrentResource

public org.apache.velocity.runtime.resource.Resource getCurrentResource()

setMacroLibraries

public void setMacroLibraries(java.util.List arg0)

getMacroLibraries

public java.util.List getMacroLibraries()

attachEventCartridge

public org.apache.velocity.app.event.EventCartridge attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0)

Specified by:

attachEventCartridge in interface org.apache.velocity.context.InternalEventContext

getEventCartridge

public org.apache.velocity.app.event.EventCartridge getEventCartridge()

Specified by:

getEventCartridge in interface org.apache.velocity.context.InternalEventContext