Class ReturnFormContext

All Implemented Interfaces:
Serializable, 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.
See Also:
  • Constructor Details

    • ReturnFormContext

      public ReturnFormContext()
  • Method Details

    • 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, Long purchasedQuantity, Long returnedQuantity)
      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(String arg0)
    • popCurrentTemplateName

      public void popCurrentTemplateName()
    • getCurrentTemplateName

      public String getCurrentTemplateName()
    • getTemplateNameStack

      public String[] getTemplateNameStack()
    • pushCurrentMacroName

      public void pushCurrentMacroName(String arg0)
    • popCurrentMacroName

      public void popCurrentMacroName()
    • getCurrentMacroName

      public String getCurrentMacroName()
    • getCurrentMacroCallDepth

      public int getCurrentMacroCallDepth()
    • getMacroNameStack

      public String[] getMacroNameStack()
    • icacheGet

      public org.apache.velocity.util.introspection.IntrospectionCacheData icacheGet(Object arg0)
    • 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

      public void setMacroLibraries(List<org.apache.velocity.Template> arg0)
    • getMacroLibraries

      public List<org.apache.velocity.Template> 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