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:
Serializable,Cloneable,org.apache.velocity.context.Context,org.apache.velocity.context.InternalEventContext
- Direct Known Subclasses:
ReturnFormContext,ReturnShippingLabelContext
Common context for velocity templates related to return form attached to either
ConsignmentModel or ReturnRequestModel- See Also:
-
Field Summary
Fields inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext
DOCUMENT_LANGUAGEFields 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 -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.velocity.app.event.EventCartridgeattachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0) escapeHtml(String stringToEscape) Escapes String to generate safe HTMLintorg.apache.velocity.runtime.resource.Resourceorg.apache.velocity.tools.generic.DateToolgetDate()protected LanguageModelgetDocumentLanguage(BusinessProcessModel businessProcessModel) org.apache.velocity.app.event.EventCartridgeList<org.apache.velocity.Template>String[]getOrder()protected AbstractOrderModelgetOrder(BusinessProcessModel businessProcessModel) GetAbstractOrderModelfrom givenBusinessProcessModelprotected AddressModelgetPosAddress(AbstractOrderModel order, WarehouseModel returnWarehouse) Extracts theAddressModelwhere the returned goods need to be shipped by the customerprotected PosSelectionStrategyprotected BaseSiteModelgetSite(BusinessProcessModel businessProcessModel) String[]org.apache.velocity.util.introspection.IntrospectionCacheDatavoidvoidinit(BusinessProcessModel businessProcessModel, DocumentPageModel documentPageModel) voidvoidvoidpushCurrentMacroName(String arg0) voidvoidsetAddress(AddressModel address) voidsetCurrentResource(org.apache.velocity.runtime.resource.Resource arg0) voidsetDate(org.apache.velocity.tools.generic.DateTool date) voidsetMacroLibraries(List<org.apache.velocity.Template> arg0) voidsetOrder(AbstractOrderModel order) voidsetPosSelectionStrategy(PosSelectionStrategy posSelectionStrategy) protected voidvalidateProcessType(BusinessProcessModel businessProcessModel) Validates that givenBusinessProcessModelis either instance ofConsignmentProcessModelorReturnProcessModelMethods inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext
getDocumentLanguageMethods 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, setUrlEncodingAttributesMethods inherited from class org.apache.velocity.VelocityContext
clone, internalContainsKey, internalGet, internalGetKeys, internalPut, internalRemoveMethods inherited from class org.apache.velocity.context.AbstractContext
containsKey, get, getChainedContext, getKeys, put, remove
-
Constructor Details
-
CommonReturnDocumentContext
public CommonReturnDocumentContext()
-
-
Method Details
-
init
- Overrides:
initin classAbstractDocumentContext<BusinessProcessModel>
-
escapeHtml
Escapes String to generate safe HTML- Parameters:
stringToEscape- String to escape- Returns:
- escaped String
-
getPosAddress
Extracts theAddressModelwhere the returned goods need to be shipped by the customer- Parameters:
order- theAbstractOrderModelfor which address needs to be calculatedreturnWarehouse- theWarehouseModelfor which address needs to be extracted- Returns:
- the
AddressModelofPointOfServiceModel
-
getOrder
GetAbstractOrderModelfrom givenBusinessProcessModel- Parameters:
businessProcessModel- theBusinessProcessModel, for whichAbstractOrderModelneeds be retrieved- Returns:
AbstractOrderModelassigned to givenBusinessProcessModel
-
getSite
- Specified by:
getSitein classAbstractDocumentContext<BusinessProcessModel>
-
getDocumentLanguage
- Specified by:
getDocumentLanguagein classAbstractDocumentContext<BusinessProcessModel>
-
validateProcessType
Validates that givenBusinessProcessModelis either instance ofConsignmentProcessModelorReturnProcessModel- Parameters:
businessProcessModel- theBusinessProcessModelto be validated
-
setDate
public void setDate(org.apache.velocity.tools.generic.DateTool date) -
setOrder
-
setAddress
-
getOrder
-
getDate
public org.apache.velocity.tools.generic.DateTool getDate() -
getAddress
-
getPosSelectionStrategy
-
setPosSelectionStrategy
-
pushCurrentTemplateName
-
popCurrentTemplateName
public void popCurrentTemplateName() -
getCurrentTemplateName
-
getTemplateNameStack
-
pushCurrentMacroName
-
popCurrentMacroName
public void popCurrentMacroName() -
getCurrentMacroName
-
getCurrentMacroCallDepth
public int getCurrentMacroCallDepth() -
getMacroNameStack
-
icacheGet
-
icachePut
public void icachePut(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
-
getMacroLibraries
-
attachEventCartridge
public org.apache.velocity.app.event.EventCartridge attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0) - Specified by:
attachEventCartridgein interfaceorg.apache.velocity.context.InternalEventContext
-
getEventCartridge
public org.apache.velocity.app.event.EventCartridge getEventCartridge()- Specified by:
getEventCartridgein interfaceorg.apache.velocity.context.InternalEventContext
-