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

Class ReturnFormContext

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

de.hybris.platform.warehousing.labels.context.ReturnFormContext

All Implemented Interfaces:

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

public class ReturnFormContext
extends CommonReturnDocumentContext

Context specific to Return Form providing methods for extracting returned items.

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
ReturnFormContext()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.event.EventCartridge	attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0)
protected ReturnFormEntry	createReturnFormEntry(AbstractOrderEntryModel orderEntry, java.lang.Long purchasedQuantity, java.lang.Long returnedQuantity)	Creates ReturnFormEntry from given AbstractOrderEntryModel
protected ReturnForm	createReturnFormForConsignment(ConsignmentModel consignment)	Creates ReturnForm which holds lists of ReturnFormEntry(s)
protected ReturnForm	createReturnFormForReturnRequest(ReturnRequestModel returnRequest)	Creates ReturnForm which holds lists of ReturnFormEntry(s)
int	getCurrentMacroCallDepth()
java.lang.String	getCurrentMacroName()
org.apache.velocity.runtime.resource.Resource	getCurrentResource()
java.lang.String	getCurrentTemplateName()
org.apache.velocity.app.event.EventCartridge	getEventCartridge()
java.util.List	getMacroLibraries()
java.lang.Object[]	getMacroNameStack()
org.apache.velocity.tools.generic.NumberTool	getNumber()
ReturnForm	getReturnForm()
boolean	getShowQuantityPurchased()
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	setCurrentResource(org.apache.velocity.runtime.resource.Resource arg0)
void	setMacroLibraries(java.util.List arg0)
void	setNumber(org.apache.velocity.tools.generic.NumberTool number)
void	setReturnForm(ReturnForm returnForm)
void	setShowQuantityPurchased(boolean flag)

Methods inherited from class de.hybris.platform.warehousing.labels.context.CommonReturnDocumentContext

escapeHtml, getAddress, getDate, getDocumentLanguage, getOrder, getOrder, getPosAddress, getPosSelectionStrategy, getSite, setAddress, setDate, setOrder, setPosSelectionStrategy, validateProcessType

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

ReturnFormContext

public ReturnFormContext()

Method Detail

init

public void init(BusinessProcessModel businessProcessModel,
                 DocumentPageModel documentPageModel)

Overrides:

init in class CommonReturnDocumentContext

createReturnFormForConsignment

protected ReturnForm createReturnFormForConsignment(ConsignmentModel consignment)

Creates ReturnForm which holds lists of ReturnFormEntry(s)

Parameters:

consignment - the given ConsignmentModel from which ReturnFormEntry(s) need to be retrieved

Returns:

ReturnForm.
Or null, if given ConsignmentModel does not have any ConsignmentEntryModel.

createReturnFormForReturnRequest

protected ReturnForm createReturnFormForReturnRequest(ReturnRequestModel returnRequest)

Creates ReturnForm which holds lists of ReturnFormEntry(s)

Parameters:

returnRequest - the given ReturnRequestModel from which ReturnFormEntry(s) need to be retrieved

Returns:

ReturnForm.
Or null, if given ReturnRequestModel does not have any ReturnEntryModel(s).

createReturnFormEntry

protected ReturnFormEntry createReturnFormEntry(AbstractOrderEntryModel orderEntry,
                                                java.lang.Long purchasedQuantity,
                                                java.lang.Long returnedQuantity)

Creates ReturnFormEntry from given AbstractOrderEntryModel

Parameters:

orderEntry - the AbstractOrderEntryModel which need to be transformed to ReturnFormEntry

purchasedQuantity - quantity of shipped items

returnedQuantity - quantity of items being returned

Returns:

ReturnFormEntry

setReturnForm

public void setReturnForm(ReturnForm returnForm)

setNumber

public void setNumber(org.apache.velocity.tools.generic.NumberTool number)

setShowQuantityPurchased

public void setShowQuantityPurchased(boolean flag)

getReturnForm

public ReturnForm getReturnForm()

getNumber

public org.apache.velocity.tools.generic.NumberTool getNumber()

getShowQuantityPurchased

public boolean getShowQuantityPurchased()

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