Class FormulaStep

    • Field Detail

      • formula

        public Formula formula
        *Primary Key* The formula that this step belongs to
      • sequence

        public int sequence
        The sequence in the formula this step belongs at. Can be set to -1 if sequence is not required in formulation
      • commodity

        public Commodity commodity
        The commodity that is associated with this step. If this is a weigh step, it's the commodity to be weighed
      • lowerTol

        public java.lang.Double lowerTol
        The lower tolerance of this step, this should be set relative to the target, not as an absolute value.
      • upperTol

        public java.lang.Double upperTol
        The upper tolerance of this step, this should be set relative to the target, not as an absolute value.
      • targetQty

        public java.lang.Double targetQty
        The target quantity for this step, should the step be scheduled at the Formula.defaultSize
      • question

        public Question question
        A question object which can be used when prompting questions or messages
      • location

        public Location location
        The location this step should appear at if you are using a flat formulation approach rather than hierarchical
      • schedule

        public int schedule
        Boolean value to indicate whether this step should be scheduled if this step's commodity is a formula type
      • scaleTol

        public int scaleTol
        Boolean value to indicate whether the tolerance should scale with the batch size. JobLine.products
      • time

        public java.lang.Integer time
        The time it should take to complete this step
      • customField1

        public java.lang.String customField1
        A custom field used for storing, printing and reporting data
      • customField2

        public java.lang.String customField2
        A custom field used for storing, printing and reporting data
      • customField3

        public java.lang.String customField3
        A custom field used for storing, printing and reporting data
      • customField4

        public java.lang.String customField4
        A custom field used for storing, printing and reporting data
      • customField5

        public java.lang.String customField5
        A custom field used for storing, printing and reporting data
      • customField6

        public java.lang.String customField6
        A custom field used for storing, printing and reporting data
      • customField7

        public java.lang.String customField7
        A custom field used for storing, printing and reporting data
      • negativeAddition

        public int negativeAddition
        Boolean value to indicate whether the terminal should operate in negative weighing mode for this step Negative weighing mode involves the operator removing the quantity from the scale rather than adding it
      • defaultBulkPlatform

        public BulkPlatform defaultBulkPlatform
        The default bulk platform to run this step on should this step be of type BulkDispense
      • loss

        public java.lang.String loss
        The loss this step experiences in the production environment. Can be expressed fixed or as a percentile.
      • optionalGroup

        public OptionalGroup optionalGroup
        The optional group that this step belongs to
      • schedBaseSize

        public int schedBaseSize
        An overriden base size to schedule should this step be a submix
      • autoConsume

        public int autoConsume
        Boolean value to specify whether this step should be automatically consumed
      • requiresApproval

        public int requiresApproval
        Boolean value to indicate whether this formula step requries approval prior to weighing
      • mixLocation

        public Location mixLocation
        The location where this item will ultimately get mixed if using bagging mode 5
      • nonTraced

        public int nonTraced
        Used to indicate that this step in this formula should not prompt for stock and act as if record stock is not set at the commodity level
      • scalePackaging

        public int scalePackaging
        Used in conjunction with Multi-lot (Key Entry). Specifies whether packaging usage should scale up with the value entered on the key entry pad. I.e. producing a double sized pack results in double the packaging consumption
      • primaryOptional

        public int primaryOptional
        For reporting purposes, this is used to tell the system which is the primary optional step. (Only effective in the optionals dialog)
      • mixStepSequence

        public java.lang.Integer mixStepSequence
        A reference to another step within this formula which should be mixed in whilst weighing this formula step. Any partial additions will send the operator to the tied formula step After the mix addition is made, you are returned to the original formula step
      • collationSequence

        public java.lang.Integer collationSequence
      • linkedStep

        public FormulaStep linkedStep
        With bagging mode 2, this is the sequence is which the terminal will have the user scan the bags in.
      • linkedStepComplete

        public boolean linkedStepComplete
      • isBeingAMixStep

        public boolean isBeingAMixStep
      • tare

        public java.lang.Double tare
        The tare value if using a preset tare
      • bagScanTerminal

        public Terminal bagScanTerminal
        The Terminal where the bags are scanned when using bagging mode
      • bulkInstructions

        public java.lang.String bulkInstructions
        Instructions to be sent with a bulk message
      • bulkTime

        public java.lang.Integer bulkTime
        Time to be sent for a bulk message
      • consumptionValue

        public int consumptionValue
    • Constructor Detail

      • FormulaStep

        public FormulaStep()
    • Method Detail

      • getFormula

        public Formula getFormula()
      • setFormula

        public void setFormula​(Formula formula)
      • getSequence

        public int getSequence()
      • setSequence

        public void setSequence​(int sequence)
      • getCommodity

        public Commodity getCommodity()
      • setCommodity

        public void setCommodity​(Commodity commodity)
      • getLowerTol

        public java.lang.Double getLowerTol()
      • setLowerTol

        public void setLowerTol​(java.lang.Double lowerTol)
      • getUpperTol

        public java.lang.Double getUpperTol()
      • setUpperTol

        public void setUpperTol​(java.lang.Double upperTol)
      • getTargetQty

        public java.lang.Double getTargetQty()
      • setTargetQty

        public void setTargetQty​(java.lang.Double targetQty)
      • getType

        public int getType()
      • setType

        public void setType​(int type)
      • getTypeEnumStr

        public java.lang.String getTypeEnumStr()
      • isComplete

        public boolean isComplete()
      • setComplete

        public void setComplete​(boolean complete)
      • setQuantityAdded

        public void setQuantityAdded​(double quantityAdded)
      • getQuantityAdded

        public double getQuantityAdded()
      • getQuantityAddedActual

        public double getQuantityAddedActual()
      • isStepSkipped

        public boolean isStepSkipped()
      • setStepSkipped

        public void setStepSkipped​(boolean stepSkipped)
      • getQuestion

        public Question getQuestion()
      • setQuestion

        public void setQuestion​(Question question)
      • setActiveStock

        public void setActiveStock​(StockLocation stock)
      • getLocation

        public Location getLocation()
      • setLocation

        public void setLocation​(Location location)
      • getDeleted

        public java.util.Date getDeleted()
      • setDeleted

        public void setDeleted​(java.util.Date deleted)
      • getSchedule

        public int getSchedule()
      • setSchedule

        public void setSchedule​(int schedule)
      • getScaleTol

        public int getScaleTol()
      • setScaleTol

        public void setScaleTol​(int scaleTol)
      • getTime

        public java.lang.Integer getTime()
      • setTime

        public void setTime​(java.lang.Integer time)
      • isBeingShifted

        public boolean isBeingShifted()
      • setBeingShifted

        public void setBeingShifted​(boolean isBeingShifted)
      • getCustomField1

        public java.lang.String getCustomField1()
      • getCustomField2

        public java.lang.String getCustomField2()
      • getCustomField3

        public java.lang.String getCustomField3()
      • getCustomField4

        public java.lang.String getCustomField4()
      • getCustomField5

        public java.lang.String getCustomField5()
      • setCustomField1

        public void setCustomField1​(java.lang.String customField1)
      • setCustomField2

        public void setCustomField2​(java.lang.String customField2)
      • setCustomField3

        public void setCustomField3​(java.lang.String customField3)
      • setCustomField4

        public void setCustomField4​(java.lang.String customField4)
      • setCustomField5

        public void setCustomField5​(java.lang.String customField5)
      • compareTo

        public int compareTo​(FormulaStep o)
        Specified by:
        compareTo in interface java.lang.Comparable<FormulaStep>
      • getCustomField6

        public java.lang.String getCustomField6()
      • getCustomField7

        public java.lang.String getCustomField7()
      • setCustomField6

        public void setCustomField6​(java.lang.String customField6)
      • setCustomField7

        public void setCustomField7​(java.lang.String customField7)
      • getNegativeAddition

        public int getNegativeAddition()
      • setNegativeAddition

        public void setNegativeAddition​(int negativeAddition)
      • getDefaultBulkPlatform

        public BulkPlatform getDefaultBulkPlatform()
      • setDefaultBulkPlatform

        public void setDefaultBulkPlatform​(BulkPlatform defaultBulkPlatform)
      • getLoss

        public java.lang.String getLoss()
      • setLoss

        public void setLoss​(java.lang.String loss)
      • getLossType

        public int getLossType()
      • setLossType

        public void setLossType​(int lossType)
      • setUnit

        public void setUnit​(WeightUnit unit)
      • setOptionalGroup

        public void setOptionalGroup​(OptionalGroup optionalGroup)
      • getActiveLotContainer

        public LotContainer getActiveLotContainer()
      • setActiveLotContainer

        public void setActiveLotContainer​(LotContainer activeLotContainer)
      • setActivePallet

        public void setActivePallet​(ContainerLink activePallet)
      • getPredeterminedGroupChoice

        public OptionalGroup getPredeterminedGroupChoice()
      • setPredeterminedGroupChoice

        public void setPredeterminedGroupChoice​(OptionalGroup predeterminedGroupChoice)
      • getTotalCost

        public java.lang.Double getTotalCost()
      • getCommodityConversionRate

        public double getCommodityConversionRate()
      • getStepConversionRate

        public double getStepConversionRate()
      • setCommodityConversionRate

        public void setCommodityConversionRate​(double commodityConversionRate)
      • setStepConversionRate

        public void setStepConversionRate​(double stepConversionRate)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getScaleTolStr

        public java.lang.String getScaleTolStr()
      • getSchedBaseSize

        public int getSchedBaseSize()
      • setSchedBaseSize

        public void setSchedBaseSize​(int schedBaseSize)
      • getLotCount

        public int getLotCount()
      • getActiveStockLots

        public java.util.List<java.lang.Object> getActiveStockLots()
      • setActiveStockLots

        public void setActiveStockLots​(java.util.List<java.lang.Object> activeStockLots)
      • getActiveStockLotsQuantity

        public java.lang.Double getActiveStockLotsQuantity()
      • addStockLot

        public void addStockLot​(java.lang.Object stock)
      • containsStockLot

        public boolean containsStockLot​(java.lang.Object stock)
      • getAutoConsume

        public int getAutoConsume()
      • setAutoConsume

        public void setAutoConsume​(int autoConsume)
      • getConvertedCost

        public java.lang.Double getConvertedCost()
      • getConvertedTotalCost

        public java.lang.Double getConvertedTotalCost()
      • setExpectedCost

        public void setExpectedCost​(java.lang.Double stockCost,
                                    java.lang.Double targetQty)
      • getExpectedCost

        public java.lang.Double getExpectedCost()
      • getRequiresApproval

        public int getRequiresApproval()
      • setRequiresApproval

        public void setRequiresApproval​(int requiresApproval)
      • getMixLocation

        public Location getMixLocation()
      • setMixLocation

        public void setMixLocation​(Location mixLocation)
      • getProductDivisor

        public double getProductDivisor()
      • setProductDivisor

        public void setProductDivisor​(double productDivisor)
      • getNonTraced

        public int getNonTraced()
      • setNonTraced

        public void setNonTraced​(int nonTraced)
      • getScalePackaging

        public int getScalePackaging()
      • setScalePackaging

        public void setScalePackaging​(int scalePackaging)
      • getPrimaryOptional

        public int getPrimaryOptional()
      • setPrimaryOptional

        public void setPrimaryOptional​(int primaryOptional)
      • setEditValue

        public void setEditValue​(java.lang.Double editValue)
      • getEditValue

        public java.lang.Double getEditValue()
      • getMixStepSequence

        public java.lang.Integer getMixStepSequence()
      • setMixStepSequence

        public void setMixStepSequence​(java.lang.Integer mixStepSequence)
      • getCollationSequence

        public java.lang.Integer getCollationSequence()
      • setCollationSequence

        public void setCollationSequence​(java.lang.Integer collationSequence)
      • setLinkedStep

        public void setLinkedStep​(FormulaStep linkedStep)
      • isBeingAMixStep

        public boolean isBeingAMixStep()
      • setBeingAMixStep

        public void setBeingAMixStep​(boolean isBeingAMixStep)
      • getTare

        public java.lang.Double getTare()
      • setTare

        public void setTare​(java.lang.Double tare)
      • getBagScanTerminal

        public Terminal getBagScanTerminal()
      • setBagScanTerminal

        public void setBagScanTerminal​(Terminal bagScanTerminal)
      • isLinkedStepComplete

        public boolean isLinkedStepComplete()
      • setLinkedStepComplete

        public void setLinkedStepComplete​(boolean linkedStepComplete)
      • getBulkInstructions

        public java.lang.String getBulkInstructions()
      • setBulkInstructions

        public void setBulkInstructions​(java.lang.String bulkInstructions)
      • getBulkTime

        public java.lang.Integer getBulkTime()
      • setBulkTime

        public void setBulkTime​(java.lang.Integer bulkTime)
      • getConsumptionValue

        public int getConsumptionValue()
      • setConsumptionValue

        public void setConsumptionValue​(int consumptionValue)