Package com.storedobject.core

Class InventoryLedger

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryLedger

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasInventoryItem, HasInventoryItemType

public final class InventoryLedger
extends StoredObject
implements HasInventoryItem, HasInventoryItemType

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryLedger()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static QuantityWithCost	getClosingStock(InventoryItemType itemType, Date date, InventoryLocation location)
Money	getCost()
Date	getDate()
InventoryItemType	getInventoryItemType()	Returns the InventoryItemType (P/N) associated with this object.
InventoryItem	getItem()	Retrieves the inventory item associated with this entity.
Id	getItemId()
InventoryItemType	getItemType()
InventoryItemType	getItemTypeFromHistory()
Id	getItemTypeId()
InventoryLocation	getLocationFrom()
Id	getLocationFromId()
InventoryLocation	getLocationTo()
Id	getLocationToId()
static QuantityWithCost	getOpeningStock(InventoryItemType itemType, Date date, InventoryLocation location)
Quantity	getQuantity()	Retrieves the quantity of the inventory item associated with this entity.
String	getReference()
static void	indices(Indices indices)
void	setCost(Money cost)
void	setCost(Object moneyValue)
void	setDate(Date date)
void	setItem(Id itemId)
void	setItem(InventoryItem item)
void	setItem(BigDecimal idValue)
void	setItemType(Id itemTypeId)
void	setItemType(InventoryItemType itemType)
void	setItemType(BigDecimal idValue)
void	setLocationFrom(Id locationId)
void	setLocationFrom(InventoryLocation location)
void	setLocationFrom(BigDecimal idValue)
void	setLocationTo(Id locationId)
void	setLocationTo(InventoryLocation location)
void	setLocationTo(BigDecimal idValue)
void	setQuantity(Quantity quantity)
void	setQuantity(Object value)
void	setReference(String reference)
void	updateCost(TransactionManager tm, Money newCost)
void	updateReference(TransactionManager tm, String newReference)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.core.HasInventoryItem

getInventoryItem, getItemFromHistory

Constructor Details

InventoryLedger

public InventoryLedger()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

setDate

public void setDate(Date date)

getDate

public Date getDate()

setItem

public void setItem(Id itemId)

setItem

public void setItem(BigDecimal idValue)

setItem

public void setItem(InventoryItem item)

getItemId

@Column(style="(any)")
public Id getItemId()

getItem

public InventoryItem getItem()

Description copied from interface: HasInventoryItem

Retrieves the inventory item associated with this entity.

Specified by:

getItem in interface HasInventoryItem

Returns:

the associated InventoryItem instance

setItemType

public void setItemType(Id itemTypeId)

setItemType

public void setItemType(BigDecimal idValue)

setItemType

public void setItemType(InventoryItemType itemType)

getItemTypeId

@Column(style="(any)")
public Id getItemTypeId()

getItemType

public InventoryItemType getItemType()

getItemTypeFromHistory

public InventoryItemType getItemTypeFromHistory()

setQuantity

public void setQuantity(Quantity quantity)

setQuantity

public void setQuantity(Object value)

getQuantity

public Quantity getQuantity()

Description copied from interface: HasInventoryItem

Retrieves the quantity of the inventory item associated with this entity.

Specified by:

getQuantity in interface HasInventoryItem

Returns:

the quantity of the associated inventory item

setCost

public void setCost(Money cost)

setCost

public void setCost(Object moneyValue)

getCost

@Column(required=false)
public Money getCost()

setLocationFrom

public void setLocationFrom(Id locationId)

setLocationFrom

public void setLocationFrom(BigDecimal idValue)

setLocationFrom

public void setLocationFrom(InventoryLocation location)

getLocationFromId

@Column(style="(any)")
public Id getLocationFromId()

getLocationFrom

public InventoryLocation getLocationFrom()

setLocationTo

public void setLocationTo(Id locationId)

setLocationTo

public void setLocationTo(BigDecimal idValue)

setLocationTo

public void setLocationTo(InventoryLocation location)

getLocationToId

@Column(style="(any)")
public Id getLocationToId()

getLocationTo

public InventoryLocation getLocationTo()

getReference

public String getReference()

setReference

public void setReference(String reference)

updateReference

public void updateReference(TransactionManager tm,
 String newReference)
                     throws Exception

Throws:

Exception

updateCost

public void updateCost(TransactionManager tm,
 Money newCost)
                throws Exception

Throws:

Exception

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getOpeningStock

public static QuantityWithCost getOpeningStock(InventoryItemType itemType,
 Date date,
 InventoryLocation location)

getClosingStock

public static QuantityWithCost getClosingStock(InventoryItemType itemType,
 Date date,
 InventoryLocation location)

getInventoryItemType

public InventoryItemType getInventoryItemType()

Description copied from interface: HasInventoryItemType

Returns the InventoryItemType (P/N) associated with this object.

Specified by:

getInventoryItemType in interface HasInventoryItem

Specified by:

getInventoryItemType in interface HasInventoryItemType

Returns:

the InventoryItemType representing the type of the inventory item (P/N).