psdi.app.inventory

Class InvBalances

java.lang.Object

psdi.mbo.Mbo

psdi.app.inventory.InvBalances

All Implemented Interfaces:

java.rmi.Remote, InvBalancesRemote, MboConstants, MboRemote, MaxRemoteProxy

public class InvBalances
extends Mbo
implements InvBalancesRemote

Mbo object to represent InvBalances.

See Inventory Package description.

This is a site level object.

The key attribute(s) in this object are as follows: SiteId,ItemSetID, Itemnum, Location, Binnum, Lotnum

The attributes in this object are as follows:

Attribute Name	Description
AdjustedPhysCnt	Non-persistent attribute used to maintain new physical count for the item in the bin. Editable for an existing InvBalances object. If value is provided, an Adjust Physcial Count function will take place and the object's PhysCnt column will be updated to the new count. See PhysCnt for more information.
AdjustedPhysCntDate	Non-persistent attribute used to maintain new physical count date for the item in the bin. Editable for an existing InvBalances object. If value is provided and the new physical count is also provided, an Adjust Physcial Count function will take place and the object's PhysCntDate column will be updated to the new date. See PhysCntDate for more information.
Binnum	Bin number of the storage location. One of four members of this object's key. This attribute is not required. See Inventory.Binnum.
Curbal	Current balances at this storage location.
Itemnum	Inventory Item Number. One of four members of this object's key. This attribute is required.
ItemSetID	Identifier of the itemset identifier for this object.
Ldkey	no description,remarks, or memo columns. To be removed.
Location	This inventory item's storeroom location. One of four members of this object's key. This attribute is required.
Lotnum	Lot Number of the item at the storage location. One of four members of this object's key. This is a required attribute for a lotted item. This is a read-only attribute for an item that is not lotted. Item.Lottype determines whether or not this is a lotted item.
OrgId	Identifier of the organization for this object.
PhysCnt	Balance from last physical count at this storage location.
PhysCntDate	Date of last physical count at this storage location.
Reconciled	Flag to indicate whether or not the balance has been reconciled.
ShelfLife	Non-persistent attribute used to maintain InvLot.ShelfLife through the InvBalances object. For lot-tracking items only. Item.Lottype determines whether or not this is a lotted item. See the ShelfLife attribute defined in ShelfLife for more information.
SiteId	Identifier of the site for this object.
UseBy	Non-persistent attribute used to maintain InvLot.UseBy through the InvBalances object. For lot-tracking items only. Item.Lottype determines whether or not this is a lotted item. See the UseBy attribute defined in UseBy for more information.

See Also:

MatRecTrans, MatUseTrans, Inventory

Field Summary

Fields

Modifier and Type	Field and Description
static MboSetRemote	distinctBinSet stores the set of distinct bins from the InvBalances table from the InvBalances table or binsHash.

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
InvBalances(MboSet ms) InvBalances Constructor Construct the InvBalances object

Method Summary

Modifier and Type	Method and Description
void	add() Sets the default the values for a new InvBalance record.
MboRemote	adjustCurrentBalance(double newBalance) adjustCurrentBalance called without passing control account and shrinkage account
MboRemote	adjustCurrentBalance(double newBalance, java.lang.String controlacc, java.lang.String shrinkageacc) Adjusts the current balance.
void	adjustLifoFifoCurrentBalance(double newBalance) Adjusts the current balance for Lifo/Fifo items.
MboRemote	adjustPhysicalCount(double quantity, java.util.Date pCountDate) Adjusts the inventory physical count.
void	appValidate() last minute validate before save().
void	canDelete() Checks whether this object can be deleted.
boolean	checkWMATStatus() Check to see if record exists in WOMATSTATUSSYNC table.
MboRemote	createInvTrans(double quantity, double unitcost, boolean isreconcile) This method creates invtrans record for the current balance adjustment for Lifo/Fifo items fr consumption.
double	getCurrentBalance() Get the current balance.
double	getNewBalanceForReconcile() This method calculates the the new current balance for the invbalance record.
double	getPhysicalCount() Returns the current Physical count
void	init() Initialization routine.
MboRemote	previewReconcileBalances() This method is used to set value for non persistent attribute
MboRemote	reconcileBalances() Reconciles balances is done at the bin/lot level.
void	reconcileBalancesLifoFifo(java.lang.String controlacc, java.lang.String shrinkageacc, java.lang.String remark) Method to reconcile balance adjustments for the inventory of LIFO/FIFO cost type.
void	reconcileLifoFifoCurrentBalance(double physcnt) This method updates the curbal and reconciled flag.
void	save() Saves the invbalances record if it is created; for a lotted item, creates invlot record if the lot number does not exist.
void	setAutoCreateInvLot(boolean flag) For a lotted item,returns true if invLot is to be automatically created or returns false if invlot is not be be automatically created.
void	updateCurrentBalance(double quantity) Updates the "curbal" (current balance) field with the value passed in
void	updateLifoFifoQtyAndCreateInvTrans(boolean isreconcile) This method checks if the item is Condition enabled.
void	updateLifoFifoQtyAndCreateInvTrans(java.util.HashMap<java.lang.String,java.util.Vector<MboRemote>> condBalMap, boolean isreconcile) This method call updateLifoFifoQuantity () for each entry in the Hash map.
void	updateLifoFifoQtyAndCreateInvTrans(java.util.Vector<MboRemote> invBalanceVec, java.lang.String conditionCode, boolean isreconcile) This method update invlifofifocost table and adjustcurrent balance for Lifo/Fifo items.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, duplicate, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail

distinctBinSet

public static MboSetRemote distinctBinSet

stores the set of distinct bins from the InvBalances table from the InvBalances table or binsHash. This set is used to populate bin lookups.

Constructor Detail

InvBalances

public InvBalances(MboSet ms)
            throws MXException,
                   java.rmi.RemoteException

InvBalances Constructor Construct the InvBalances object

Parameters:

ms - (The calling MBOSet)

Throws:

MXException

java.rmi.RemoteException

Method Detail

updateCurrentBalance

public void updateCurrentBalance(double quantity)
                          throws MXException,
                                 java.rmi.RemoteException

Updates the "curbal" (current balance) field with the value passed in

Specified by:

updateCurrentBalance in interface InvBalancesRemote

Parameters:

quantity - New value for the "curbal" attribute

Throws:

none

MXException

java.rmi.RemoteException

See Also:

updateCurrentBalance(double)

getPhysicalCount

public double getPhysicalCount()
                        throws MXException,
                               java.rmi.RemoteException

Returns the current Physical count

Specified by:

getPhysicalCount in interface InvBalancesRemote

Parameters:

none -

Returns:

The current physical count

Throws:

none

MXException

java.rmi.RemoteException

See Also:

getPhysicalCount()

getCurrentBalance

public double getCurrentBalance()
                         throws MXException,
                                java.rmi.RemoteException

Get the current balance.

Specified by:

getCurrentBalance in interface InvBalancesRemote

Parameters:

none -

Returns:

The current balance

Throws:

none

MXException

java.rmi.RemoteException

See Also:

getCurrentBalance()

init

public void init()
          throws MXException

Initialization routine.
Set field flags for attributes that are always readonly as well as those fields which are editable only during insert.

Overrides:

init in class Mbo

Parameters:

none -

Throws:

none

MXException

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Sets the default the values for a new InvBalance record. The table below shows the default values for each of the attributes listed.

Attribute Name	Attribute Value
itemnum	Current itemnum
itemsetid	Current itemsetid
location	Current location
reconciled	false
curbal	0(zero)
physcnt	0(zero)
physcntdate	Current date

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Parameters:

none -

Throws:

MXApplicationException -

GROUP	KEY	REASON
inventory	invBalNoAdd	if the owner of this object is not Inventory

MXException

java.rmi.RemoteException

adjustPhysicalCount

public MboRemote adjustPhysicalCount(double quantity,
                                     java.util.Date pCountDate)
                              throws MXException,
                                     java.rmi.RemoteException

Adjusts the inventory physical count.
Note that this method only updates the physical count - it does not reconcile current balance with physical count.

Specified by:

adjustPhysicalCount in interface InvBalancesRemote

Parameters:

pCountDate - Physical Count Date

quantity - New PHYSCNT quantity

Returns:

MboRemote

Throws:

MXApplicationException - if the item is rotating

GROUP	KEY	REASON
inventory	adjPhysCntItemRotating	if the item is rotating

MXException

java.rmi.RemoteException

See Also:

adjustPhysicalCount(double, java.util.Date)

adjustCurrentBalance

public MboRemote adjustCurrentBalance(double newBalance)
                               throws MXException,
                                      java.rmi.RemoteException

adjustCurrentBalance called without passing control account and shrinkage account

Specified by:

adjustCurrentBalance in interface InvBalancesRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

adjustCurrentBalance(double)

adjustCurrentBalance

public MboRemote adjustCurrentBalance(double newBalance,
                                      java.lang.String controlacc,
                                      java.lang.String shrinkageacc)
                               throws MXException,
                                      java.rmi.RemoteException

Adjusts the current balance.

Parameters:

newBalance - The new balance

controlacc - control account

shrinkageacc - shrinkage account

Returns:

The InvTrans record that was added during this transaction

Throws:

MXApplicationException -

GROUP	KEY	REASON
inventory	adjCurBalItemRotating	if the item is rotating
inventory	adjCurBalNoChange	if there is no change in the balance

MXException

java.rmi.RemoteException

reconcileBalances

public MboRemote reconcileBalances()
                            throws MXException,
                                   java.rmi.RemoteException

Reconciles balances is done at the bin/lot level.
The new current balance is determined by taking into account any issues, transfers, receipts and returns that may have taken place between the time of the physical count and the time of the reconcile.
The reconcile routine will only apply to records in INVBALANCES which have RECONCILED = N.

 The Current ( Expected ) Balance
   = Physical Count (INVBALANCES.PHYSCNT)
   + Transfers In (after the physical count date)
   - Transfers Out (after the physical count date)
   + Returns (after the physical count date)
   - Issues (after the physical count date).
 

Specified by:

reconcileBalances in interface InvBalancesRemote

Parameters:

none -

Returns:

Returns the InvTrans record that was added during this transaction

Throws:

MXApplicationException -

GROUP	KEY	REASON
inventory	invbalCannotReconcile	if the InvBalance record has already been reconciled

MXException

java.rmi.RemoteException

See Also:

reconcileBalances()

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

Checks whether this object can be deleted.

Overrides:

canDelete in class Mbo

Throws:

MXAccessException

MXApplicationException -

GROUP	KEY	REASON
access	notauthorized	if the owner is not Inventory
inventory	noDeleteInvBal	if the balance is greater than zero for this set

MXException

java.rmi.RemoteException

setAutoCreateInvLot

public void setAutoCreateInvLot(boolean flag)
                         throws MXException,
                                java.rmi.RemoteException

For a lotted item,returns true if invLot is to be automatically created or returns false if invlot is not be be automatically created.

Specified by:

setAutoCreateInvLot in interface InvBalancesRemote

Parameters:

flag - true or false to indicate if an invlot is to be automatically created.

Throws:

none

MXException

java.rmi.RemoteException

See Also:

setAutoCreateInvLot(boolean)

appValidate

public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException

last minute validate before save(). One can not enter same combination of itemnum/location/binnum/lotnum for a given site.

Overrides:

appValidate in class Mbo

Throws:

invbalAlreadyExists

MXException

java.rmi.RemoteException

save

public void save()
          throws MXException,
                 java.rmi.RemoteException

Saves the invbalances record if it is created; for a lotted item, creates invlot record if the lot number does not exist.
Calls super.save() after working on the other objects.

Parameters:

none -

Throws:

none

MXException

java.rmi.RemoteException

adjustLifoFifoCurrentBalance

public void adjustLifoFifoCurrentBalance(double newBalance)
                                  throws MXException,
                                         java.rmi.RemoteException

Adjusts the current balance for Lifo/Fifo items.

Parameters:

newBalance - The new balance

Throws:

MXException

java.rmi.RemoteException

createInvTrans

public MboRemote createInvTrans(double quantity,
                                double unitcost,
                                boolean isreconcile)
                         throws MXException,
                                java.rmi.RemoteException

This method creates invtrans record for the current balance adjustment for Lifo/Fifo items fr consumption.

Parameters:

quantity -

unitcost -

Throws:

MXException

java.rmi.RemoteException

getNewBalanceForReconcile

public double getNewBalanceForReconcile()
                                 throws MXException,
                                        java.rmi.RemoteException

This method calculates the the new current balance for the invbalance record. It calculates by subtracting the issues and transfer out from storeroom and adding transfer in and returns to the storeroom to the physical count balance.

Returns:

new balance (current balance after reconcile)

Throws:

MXException

java.rmi.RemoteException

reconcileBalancesLifoFifo

public void reconcileBalancesLifoFifo(java.lang.String controlacc,
                                      java.lang.String shrinkageacc,
                                      java.lang.String remark)
                               throws MXException,
                                      java.rmi.RemoteException

Method to reconcile balance adjustments for the inventory of LIFO/FIFO cost type.

Throws:

MXException

java.rmi.RemoteException

updateLifoFifoQtyAndCreateInvTrans

public void updateLifoFifoQtyAndCreateInvTrans(boolean isreconcile)
                                        throws MXException,
                                               java.rmi.RemoteException

This method checks if the item is Condition enabled. It calls method to create map of InvBalance records and updates the quantity in invlifofifoCost table.

Throws:

MXException

java.rmi.RemoteException

updateLifoFifoQtyAndCreateInvTrans

public void updateLifoFifoQtyAndCreateInvTrans(java.util.HashMap<java.lang.String,java.util.Vector<MboRemote>> condBalMap,
                                               boolean isreconcile)
                                        throws MXException,
                                               java.rmi.RemoteException

This method call updateLifoFifoQuantity () for each entry in the Hash map.

Parameters:

HashMap -

Throws:

MXException

java.rmi.RemoteException

updateLifoFifoQtyAndCreateInvTrans

public void updateLifoFifoQtyAndCreateInvTrans(java.util.Vector<MboRemote> invBalanceVec,
                                               java.lang.String conditionCode,
                                               boolean isreconcile)
                                        throws MXException,
                                               java.rmi.RemoteException

This method update invlifofifocost table and adjustcurrent balance for Lifo/Fifo items.

Parameters:

HashMap -

Throws:

MXException

java.rmi.RemoteException

reconcileLifoFifoCurrentBalance

public void reconcileLifoFifoCurrentBalance(double physcnt)
                                     throws MXException,
                                            java.rmi.RemoteException

This method updates the curbal and reconciled flag. This method will be called after adding the inventory transaction.

Parameters:

physcnt -

Throws:

MXException

java.rmi.RemoteException

checkWMATStatus

public boolean checkWMATStatus()
                        throws MXException

Check to see if record exists in WOMATSTATUSSYNC table.

Returns:

record exists

Throws:

MXException

previewReconcileBalances

public MboRemote previewReconcileBalances()
                                   throws MXException,
                                          java.rmi.RemoteException

This method is used to set value for non persistent attribute

Returns:

MboRemote

Throws:

MXException

java.rmi.RemoteException