Package com.storedobject.core

Class InventoryGRNItem

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryGRNItem

All Implemented Interfaces:

Displayable, StringFiller, Detail, HasId, HasInventoryItem, HasInventoryItemType

public final class InventoryGRNItem
extends StoredObject
implements Detail, HasInventoryItem

Items in a GRN. See InventoryGRN.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryGRNItem()

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
List<Tax>	computeTax(Date date, TaxRegion region, Currency localCurrency)
InventoryBin	getBin()
Id	getBinId()
Money	getCost()	Get cost of this item (excluding item-tax if any).
boolean	getInspected()
InventoryItemType	getInventoryItemType()	Returns the InventoryItemType (P/N) associated with this object.
InventoryItem	getItem()	Retrieves the inventory item associated with this entity.
Id	getItemId()
InventoryItemType	getPartNumber()
Id	getPartNumberId()
InventoryPOItem	getPOItem()
Quantity	getQuantity()	Retrieves the quantity of the inventory item associated with this entity.
String	getSerialNumber()
String	getSerialNumberDisplay()
Money	getTax()	Gte the tax amount for this entry.
Money	getUnitCost()
void	inspect(Transaction transaction)
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
static String[]	protectedColumns()
void	setBin(Id binId)
void	setBin(InventoryBin bin)
void	setBin(BigDecimal idValue)
void	setInspected(boolean inspected)
void	setItem(Id itemId)
void	setItem(InventoryItem item)
void	setItem(BigDecimal idValue)
void	setPartNumber(Id partNumberId)
void	setPartNumber(InventoryItemType partNumber)
void	setPartNumber(BigDecimal idValue)
void	setQuantity(Quantity quantity)
void	setQuantity(Object value)
void	setSerialNumber(String serialNumber)
void	setUnitCost(Money unitCost)
void	setUnitCost(Object moneyValue)
void	splitQuantity(Transaction transaction, Quantity quantityToSplit)
String	toString()	String representation of the instance.
boolean	updateValues(TransactionManager tm, Quantity newQuantity, Money newUnitCost, String newSerialNumber)	Update various attribute values.
void	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

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, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, 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.Detail

copyValuesFrom, getId, getUniqueId, getUniqueValue

Methods inherited from interface com.storedobject.core.HasInventoryItem

getInventoryItem, getItemFromHistory

Constructor Details

InventoryGRNItem

public InventoryGRNItem()

Method Details

columns

public static void columns(Columns columns)

protectedColumns

public static String[] protectedColumns()

browseColumns

public static String[] browseColumns()

setPartNumber

public void setPartNumber(Id partNumberId)

setPartNumber

public void setPartNumber(BigDecimal idValue)

setPartNumber

public void setPartNumber(InventoryItemType partNumber)

getPartNumberId

@Column(style="(any)",
        order=100)
public Id getPartNumberId()

getPartNumber

public InventoryItemType getPartNumber()

setSerialNumber

public void setSerialNumber(String serialNumber)

getSerialNumber

@Column(order=200,
        required=false)
public String getSerialNumber()

getSerialNumberDisplay

public String getSerialNumberDisplay()

setQuantity

public void setQuantity(Quantity quantity)

setQuantity

public void setQuantity(Object value)

getQuantity

@SetNotAllowed
@Column(order=300)
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

setUnitCost

public void setUnitCost(Money unitCost)

setUnitCost

public void setUnitCost(Object moneyValue)

getUnitCost

@Column(order=400,
        required=false)
public Money getUnitCost()

setBin

public void setBin(Id binId)

setBin

public void setBin(BigDecimal idValue)

setBin

public void setBin(InventoryBin bin)

getBinId

@Column(style="(any)",
        required=false,
        order=600)
public Id getBinId()

getBin

public InventoryBin getBin()

setItem

public void setItem(Id itemId)

setItem

public void setItem(BigDecimal idValue)

setItem

public void setItem(InventoryItem item)

getItemId

@Column(style="(any)",
        required=false,
        order=700)
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

setInspected

public void setInspected(boolean inspected)

getInspected

@SetNotAllowed
@Column(order=800)
public boolean getInspected()

getCost

public Money getCost()

Get cost of this item (excluding item-tax if any).

Returns:

Cost excluding item-tax if any.

getTax

public Money getTax()

Gte the tax amount for this entry.

Returns:

Tax amount.

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.

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/undeleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating the state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc., are used to check the specific states, but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate-methods is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Overrides:

validate in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

inspect

public void inspect(Transaction transaction)
             throws Exception

Throws:

Exception

isDetailOf

public boolean isDetailOf(Class<? extends StoredObject> masterClass)

Description copied from interface: Detail

Check if the given class is a "master" for this class. (Must return a consistent value).

Specified by:

isDetailOf in interface Detail

Parameters:

masterClass - Class to check.

Returns:

True if it is a "master" to this detail class. Otherwise, false.

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

splitQuantity

public void splitQuantity(Transaction transaction,
 Quantity quantityToSplit)
                   throws Exception

Throws:

Exception

updateValues

public boolean updateValues(TransactionManager tm,
 Quantity newQuantity,
 Money newUnitCost,
 String newSerialNumber)
                     throws Exception

Update various attribute values.

Parameters:

tm - Transaction manager.

newQuantity - New quantity (Could be null if change not required).

newUnitCost - New unit cost (Could be null if change not required).

newSerialNumber - New serial number (Could be null if change not required).

Returns:

True if the values are updated.

Throws:

Exception - If an error occurs while updating the value.

getPOItem

public InventoryPOItem getPOItem()

computeTax

public List<Tax> computeTax(Date date,
 TaxRegion region,
 Currency localCurrency)

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).