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:
Serializable,Cloneable,org.apache.velocity.context.Context,org.apache.velocity.context.InternalEventContext
Context specific to Return Form providing methods for extracting returned items.
- 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) protected ReturnFormEntrycreateReturnFormEntry(AbstractOrderEntryModel orderEntry, Long purchasedQuantity, Long returnedQuantity) CreatesReturnFormEntryfrom givenAbstractOrderEntryModelprotected ReturnFormcreateReturnFormForConsignment(ConsignmentModel consignment) CreatesReturnFormwhich holds lists ofReturnFormEntry(s)protected ReturnFormcreateReturnFormForReturnRequest(ReturnRequestModel returnRequest) CreatesReturnFormwhich holds lists ofReturnFormEntry(s)intorg.apache.velocity.runtime.resource.Resourceorg.apache.velocity.app.event.EventCartridgeList<org.apache.velocity.Template>String[]org.apache.velocity.tools.generic.NumberToolbooleanString[]org.apache.velocity.util.introspection.IntrospectionCacheDatavoidvoidinit(BusinessProcessModel businessProcessModel, DocumentPageModel documentPageModel) voidvoidvoidpushCurrentMacroName(String arg0) voidvoidsetCurrentResource(org.apache.velocity.runtime.resource.Resource arg0) voidsetMacroLibraries(List<org.apache.velocity.Template> arg0) voidsetNumber(org.apache.velocity.tools.generic.NumberTool number) voidsetReturnForm(ReturnForm returnForm) voidsetShowQuantityPurchased(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, validateProcessTypeMethods 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
-
ReturnFormContext
public ReturnFormContext()
-
-
Method Details
-
init
- Overrides:
initin classCommonReturnDocumentContext
-
createReturnFormForConsignment
CreatesReturnFormwhich holds lists ofReturnFormEntry(s)- Parameters:
consignment- the givenConsignmentModelfrom whichReturnFormEntry(s) need to be retrieved- Returns:
ReturnForm.
Or null, if givenConsignmentModeldoes not have anyConsignmentEntryModel.
-
createReturnFormForReturnRequest
CreatesReturnFormwhich holds lists ofReturnFormEntry(s)- Parameters:
returnRequest- the givenReturnRequestModelfrom whichReturnFormEntry(s) need to be retrieved- Returns:
ReturnForm.
Or null, if givenReturnRequestModeldoes not have anyReturnEntryModel(s).
-
createReturnFormEntry
protected ReturnFormEntry createReturnFormEntry(AbstractOrderEntryModel orderEntry, Long purchasedQuantity, Long returnedQuantity) CreatesReturnFormEntryfrom givenAbstractOrderEntryModel- Parameters:
orderEntry- theAbstractOrderEntryModelwhich need to be transformed toReturnFormEntrypurchasedQuantity- quantity of shipped itemsreturnedQuantity- quantity of items being returned- Returns:
ReturnFormEntry
-
setReturnForm
-
setNumber
public void setNumber(org.apache.velocity.tools.generic.NumberTool number) -
setShowQuantityPurchased
public void setShowQuantityPurchased(boolean flag) -
getReturnForm
-
getNumber
public org.apache.velocity.tools.generic.NumberTool getNumber() -
getShowQuantityPurchased
public boolean getShowQuantityPurchased() -
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
-