Package com.sgs.common.database

Class Commodity

  • public class Commodity
extends HibernateObject
    This class represents a commodity. Commodities form the main building blocks for the whole system. Commodities are received, used in formulas and shipped amongst many other things They represent ingredients, formulas and finished goods
    Author:
    SGSystems

    • Field Detail

      • code

        public java.lang.String code
        *Primary key* The unique code, SKU or Manufacturing Part Number to identify this item by

      • description

        public java.lang.String description
        A description of this commodity, usually something more human readable than the code

      • type

        public int type
        The type of Commodity @see CommodityType

      • units

        public WeightUnit units
        The default stocking unit for this commodity

      • bulkUnit

        public WeightUnit bulkUnit
        If applicable, the bulk unit this commodity is handled in. E.g. Bags/Bins/Totes

      • bulkQuantity

        public java.lang.Double bulkQuantity
        The quantity it takes to fill one bulkUnit in terms of units

      • gtin

        public java.lang.String gtin
        The Global Trade Identification Number for this commodity

      • cost

        public java.lang.Double cost
        The cost of this commodity per 1 units

      • recordStock

        public int recordStock
        boolean flag to indicate whether stock should be recorded for this commodity. For traceability, set this to 1. Set to 0 for items which do not need to be tracked such as water

      • defExpiryDays

        public java.lang.Integer defExpiryDays
        The default number of days from receipt until this item expires. When an item is received, this default can be automatically applied.

      • defaultQty

        public java.lang.Double defaultQty
        The standard quantity received for this item

      • defaultStockLocation

        public Location defaultStockLocation
        The standard putaway location for this item upon receipt. This could be a holding area or dock.

      • defaultSupplier

        public Client defaultSupplier
        The usual default supplier. This can be overridden with SupplierCommodities @see SupplierCommodity

      • defaultLowTol

        public java.lang.Double defaultLowTol
        The default lower tolerance for this item when inputting it into a formula

      • defaultHighTol

        public java.lang.Double defaultHighTol
        The default upper tolerance for this item when inputting it into a formula

      • receiptContainer

        public Container receiptContainer
        The standard container used for receiving this item (tare purposes mainly)

      • batchContainer

        public Container batchContainer
        The standard container used when batching this item (tare purposes mainly)

      • upc

        public java.lang.String upc
        The UPC code for this commodity

      • cleardownThreshold

        public java.lang.Double cleardownThreshold
        The level at which the system will prompt to ask if the operator would like to cleardown the remaining stock on the system. For example, if set to 2LB, when a stock lot reached less than 2LB, the operator would be asked if any was physically remaining in the bag and auto-zero thereafter.

      • purchasingNotes

        public java.lang.String purchasingNotes
        Notes to carry over to purchase orders for the receipt of this good

      • bulkPlatform

        public BulkPlatform bulkPlatform
        The bulk platform that this item is dispensed from if applicable

      • saleDenominationType

        public int saleDenominationType
        The style in which this item is sold. Not applicable to most deployments Commodity.DenominationType

      • warningLevel

        public java.lang.Double warningLevel
        Similar to cleardownThreshold but with a warning instead of a cleardown

      • packQty

        public java.lang.Double packQty
        How many items fit in a pack of this commodity (for finished goods mainly)

      • unitDisplayMode

        public int unitDisplayMode
        Affects which units are available for selection in Control Center PO/SO if using UnitCommodity

      • datafield1

        public java.lang.String datafield1
        A datafield for optional use, storage and label printing

      • datafield2

        public java.lang.String datafield2
        A datafield for optional use, storage and label printing

      • datafield3

        public java.lang.String datafield3
        A datafield for optional use, storage and label printing

      • datafield4

        public java.lang.String datafield4
        A datafield for optional use, storage and label printing

      • datafield5

        public java.lang.String datafield5
        A datafield for optional use, storage and label printing

      • datafield6

        public java.lang.String datafield6
        A datafield for optional use, storage and label printing

      • datafield7

        public java.lang.String datafield7
        A datafield for optional use, storage and label printing

      • expiryMethod

        public int expiryMethod
        How expiry should be calculated upon receipt of this item. Commodity.ExpiryMethod

      • expiryMask

        public java.lang.String expiryMask
        The format mask to be used if the appropriate field is selected for Expiry Method

      • containerized

        public int containerized
        Marks whether this commodity is containerized and we are using LotContainers for this item in the system LotContainer

      • manufacturerPartNumber

        public java.lang.String manufacturerPartNumber
        The manufacturer part number for this item

      • productOf

        public Commodity productOf
        The item for which this item is a product of

      • withdrawThreshold

        public java.lang.Double withdrawThreshold
        The level at which withdrawal should be performed. See cleardownThreshold

      • physicalWidth

        public java.lang.Double physicalWidth
        The physical width of this item (applicable to packaged items)

      • physicalHeight

        public java.lang.Double physicalHeight
        The physical height of this item (applicable to packaged items)

      • physicalDepth

        public java.lang.Double physicalDepth
        The physical depth of this item (applicable to packaged items)

      • palletized

        public int palletized
        Marks whether the commodity is palletized. If the commodity is palletized, it will be treated as such throughout receipt, manufacture and shipping and stock selection will require the scanning of an LPN.

      • negativeLotChangeAllowance

        public java.lang.Double negativeLotChangeAllowance
        How far below zero the commodity is allowed to go before a lot change is forced

      • exemptFromInitialization

        public int exemptFromInitialization
        Stops the items selected lot from being set to zero when using the Initialize Inventory module

      • adjustmentTolerance

        public java.lang.Double adjustmentTolerance
        The percentile by which this commodity is allowed to be adjusted within the context of a formulation

      • maxNumberOfPallets

        public java.lang.Double maxNumberOfPallets
        The maximum number of pallets allowed per delivery. See palletized

      • skipSupplierBatchEntry

        public int skipSupplierBatchEntry
        Marks if the commodity does not need Supplier Lot Number

      • requiresExpiryChange

        public int requiresExpiryChange
        Item requires an Expiry Date change when it's moved to another Location

      • tax

        public Tax tax
        Tax information for this commodity

      • moq

        public java.lang.Double moq
        Minimum order quantity

      • locationGroup

        public LocationGroup locationGroup
        The group of locations associated with this commodity

      • useBulkUOMForPO

        public int useBulkUOMForPO
        Indicates if bulk UOM is used for purchase orders

      • requireReceiptReason

        public int requireReceiptReason
        boolean flag to indicate whether stock should be recorded for this commodity. For traceability, set this to 1. Set to 0 for items which do not need to be tracked such as water

      • useBulkUOMForTransfer

        public int useBulkUOMForTransfer
        Indicates if bulk UOM is used for transfers

      • specificBaseConversionRate

        public java.lang.Double specificBaseConversionRate
        Not Used Anymore - Consult UnitCommodity

      • lastCycleCount

        public java.util.Date lastCycleCount

      • commodityTypeString

        public java.lang.String commodityTypeString

      • denominationTypeString

        public java.lang.String denominationTypeString

      • unitDisplayModeString

        public java.lang.String unitDisplayModeString

      • expiryMethodString

        public java.lang.String expiryMethodString

    • Constructor Detail

      • Commodity

        public Commodity()

    • Method Detail

      • getCommodityTypeString

        public java.lang.String getCommodityTypeString()

      • getDenominationTypeString

        public java.lang.String getDenominationTypeString()

      • getUnitDisplayModeString

        public java.lang.String getUnitDisplayModeString()

      • getExpiryMethodString

        public java.lang.String getExpiryMethodString()

      • getCode

        public java.lang.String getCode()

      • setCode

        public void setCode​(java.lang.String code)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • getType

        public int getType()

      • setType

        public void setType​(int type)

      • setUnits

        public void setUnits​(WeightUnit units)

      • setBulkUnit

        public void setBulkUnit​(WeightUnit bulkUnit)

      • getBulkQuantity

        public java.lang.Double getBulkQuantity()

      • setBulkQuantity

        public void setBulkQuantity​(java.lang.Double bulkQuantity)

      • getGtin

        public java.lang.String getGtin()

      • setGtin

        public void setGtin​(java.lang.String gtin)

      • getCost

        public java.lang.Double getCost()

      • setCost

        public void setCost​(java.lang.Double cost)

      • getRecordStock

        public int getRecordStock()

      • setRecordStock

        public void setRecordStock​(int recordStock)

      • getDefExpiryDays

        public java.lang.Integer getDefExpiryDays()

      • setDefExpiryDays

        public void setDefExpiryDays​(java.lang.Integer defExpiryDays)

      • getLotIncrement

        public int getLotIncrement()

      • setLotIncrement

        public void setLotIncrement​(int lotIncrement)

      • getDeleted

        public java.util.Date getDeleted()

      • setDeleted

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

      • getDefaultQty

        public java.lang.Double getDefaultQty()

      • getDefaultStockLocation

        public Location getDefaultStockLocation()

      • setDefaultQty

        public void setDefaultQty​(java.lang.Double defaultQty)

      • setDefaultStockLocation

        public void setDefaultStockLocation​(Location defaultStockLocation)

      • getDefaultSupplier

        public Client getDefaultSupplier()

      • setDefaultSupplier

        public void setDefaultSupplier​(Client defaultSupplier)

      • getDefaultLowTol

        public java.lang.Double getDefaultLowTol()

      • getDefaultHighTol

        public java.lang.Double getDefaultHighTol()

      • setDefaultLowTol

        public void setDefaultLowTol​(java.lang.Double defaultLowTol)

      • setDefaultHighTol

        public void setDefaultHighTol​(java.lang.Double defaultHighTol)

      • toString

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

      • getCodeDescString

        public java.lang.String getCodeDescString()

      • setCodeDescString

        public void setCodeDescString​(java.lang.String codeDescString)

      • setShowCode

        public void setShowCode​(boolean b)

      • getReceiptContainer

        public Container getReceiptContainer()

      • getBatchContainer

        public Container getBatchContainer()

      • setReceiptContainer

        public void setReceiptContainer​(Container receiptContainer)

      • setBatchContainer

        public void setBatchContainer​(Container batchContainer)

      • getUpc

        public java.lang.String getUpc()

      • setUpc

        public void setUpc​(java.lang.String upc)

      • getCleardownThreshold

        public java.lang.Double getCleardownThreshold()

      • setCleardownThreshold

        public void setCleardownThreshold​(java.lang.Double cleardownThreshold)

      • getPurchasingNotes

        public java.lang.String getPurchasingNotes()

      • setPurchasingNotes

        public void setPurchasingNotes​(java.lang.String purchasingNotes)

      • getSpecificBaseConversionRate

        public java.lang.Double getSpecificBaseConversionRate()

      • setSpecificBaseConversionRate

        public void setSpecificBaseConversionRate​(java.lang.Double specificBaseConversionRate)

      • setBulkPlatform

        public void setBulkPlatform​(BulkPlatform bulkPlatform)

      • getSaleDenominationType

        public int getSaleDenominationType()

      • setSaleDenominationType

        public void setSaleDenominationType​(int saleDenominationType)

      • getWarningLevel

        public java.lang.Double getWarningLevel()

      • setWarningLevel

        public void setWarningLevel​(java.lang.Double warningLevel)

      • isShowCode

        public boolean isShowCode()

      • getPackQty

        public java.lang.Double getPackQty()

      • setPackQty

        public void setPackQty​(java.lang.Double packQty)

      • getTotalStockQuantity

        public double getTotalStockQuantity()

      • setTotalStockQuantity

        public void setTotalStockQuantity​(double totalStockQuantity)

      • getLastCycleCount

        public java.util.Date getLastCycleCount()

      • setLastCycleCount

        public void setLastCycleCount​(java.util.Date lastCycleCount)

      • getUnitDisplayMode

        public int getUnitDisplayMode()

      • setUnitDisplayMode

        public void setUnitDisplayMode​(int unitDisplayMode)

      • getDatafield1

        public java.lang.String getDatafield1()

      • setDatafield1

        public void setDatafield1​(java.lang.String datafield1)

      • getDatafield2

        public java.lang.String getDatafield2()

      • setDatafield2

        public void setDatafield2​(java.lang.String datafield2)

      • getDatafield3

        public java.lang.String getDatafield3()

      • setDatafield3

        public void setDatafield3​(java.lang.String datafield3)

      • getDatafield4

        public java.lang.String getDatafield4()

      • setDatafield4

        public void setDatafield4​(java.lang.String datafield4)

      • getDatafield5

        public java.lang.String getDatafield5()

      • setDatafield5

        public void setDatafield5​(java.lang.String datafield5)

      • getDatafield6

        public java.lang.String getDatafield6()

      • setDatafield6

        public void setDatafield6​(java.lang.String datafield6)

      • getDatafield7

        public java.lang.String getDatafield7()

      • setDatafield7

        public void setDatafield7​(java.lang.String datafield7)

      • getExpiryMethod

        public int getExpiryMethod()

      • setExpiryMethod

        public void setExpiryMethod​(int expiryMethod)

      • getExpiryMask

        public java.lang.String getExpiryMask()

      • setExpiryMask

        public void setExpiryMask​(java.lang.String expiryMask)

      • getContainerized

        public int getContainerized()

      • setContainerized

        public void setContainerized​(int containerized)

      • getManufacturerPartNumber

        public java.lang.String getManufacturerPartNumber()

      • setManufacturerPartNumber

        public void setManufacturerPartNumber​(java.lang.String manufacturerPartNumber)

      • getProductOf

        public Commodity getProductOf()

      • setProductOf

        public void setProductOf​(Commodity productOf)

      • getWithdrawThreshold

        public java.lang.Double getWithdrawThreshold()

      • setWithdrawThreshold

        public void setWithdrawThreshold​(java.lang.Double withdrawThreshold)

      • getPhysicalWidth

        public java.lang.Double getPhysicalWidth()

      • getPhysicalHeight

        public java.lang.Double getPhysicalHeight()

      • getPhysicalDepth

        public java.lang.Double getPhysicalDepth()

      • setPhysicalWidth

        public void setPhysicalWidth​(java.lang.Double physicalWidth)

      • setPhysicalHeight

        public void setPhysicalHeight​(java.lang.Double physicalHeight)

      • setPhysicalDepth

        public void setPhysicalDepth​(java.lang.Double physicalDepth)

      • getTotalAverageCost

        public double getTotalAverageCost()

      • setTotalAverageCost

        public void setTotalAverageCost​(double totalAverageCost)

      • getPalletized

        public int getPalletized()

      • setPalletized

        public void setPalletized​(int palletized)

      • getNegativeLotChangeAllowance

        public java.lang.Double getNegativeLotChangeAllowance()

      • setNegativeLotChangeAllowance

        public void setNegativeLotChangeAllowance​(java.lang.Double negativeLotChangeAllowance)

      • getExemptFromInitialization

        public int getExemptFromInitialization()

      • setExemptFromInitialization

        public void setExemptFromInitialization​(int exemptFromInitialization)

      • getAdjustmentTolerance

        public java.lang.Double getAdjustmentTolerance()

      • setAdjustmentTolerance

        public void setAdjustmentTolerance​(java.lang.Double adjustmentTolerance)

      • getMaxNumberOfPallets

        public java.lang.Double getMaxNumberOfPallets()

      • setMaxNumberOfPallets

        public void setMaxNumberOfPallets​(java.lang.Double maxNumberOfPallets)

      • getSkipSupplierBatchEntry

        public int getSkipSupplierBatchEntry()

      • setSkipSupplierBatchEntry

        public void setSkipSupplierBatchEntry​(int skipSupplierBatchEntry)

      • getTax

        public Tax getTax()

      • setTax

        public void setTax​(Tax tax)

      • getMoq

        public java.lang.Double getMoq()

      • setMoq

        public void setMoq​(java.lang.Double moq)

      • getRequiresExpiryChange

        public int getRequiresExpiryChange()

      • setRequiresExpiryChange

        public void setRequiresExpiryChange​(int requiresExpiryChange)

      • setLocationGroup

        public void setLocationGroup​(LocationGroup locationGroup)

      • getUseBulkUOMForPO

        public int getUseBulkUOMForPO()

      • setUseBulkUOMForPO

        public void setUseBulkUOMForPO​(int useBulkUOMForPO)

      • getRequireReceiptReason

        public int getRequireReceiptReason()

      • setRequireReceiptReason

        public void setRequireReceiptReason​(int requireReceiptReason)

      • getUseBulkUOMForTransfer

        public int getUseBulkUOMForTransfer()

      • setUseBulkUOMForTransfer

        public void setUseBulkUOMForTransfer​(int useBulkUOMForTransfer)