Package com.storedobject.core

Class InventoryGRN

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryGRN

All Implemented Interfaces:

Displayable, StringFiller, HasChildren, HasId, HasReference, OfEntity, TriggerChangeEvent

@Table(anchors="Store")
public final class InventoryGRN
extends StoredObject
implements OfEntity, HasChildren, HasReference, TriggerChangeEvent

GRN class. Used to accept items received from a supplier.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.core.HasReference

HasReference.Amend<T extends StoredObject>

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryGRN()

Method Summary

Modifier and Type	Method	Description
static String	actionPrefixForUI()
static String[]	browseColumns()
void	close(Transaction transaction)
static void	columns(Columns columns)
void	computeLandedCost(TransactionManager tm)	Compute/recompute the landed cost.
void	computeTax(TransactionManager tm, TaxRegion region)
void	correctExchangeRate(Transaction transaction, Rate exchangeRate)
Money	getAmount()
String	getCurrency()
Currency	getCurrencyObject()
Date	getDate()
Rate	getExchangeRate()
Date	getInvoiceDate()
String	getInvoiceNumber()
Money	getLandedCost()
int	getNo()
String	getReference()
String	getReferenceNumber()
int	getStatus()
String	getStatusValue()
static String[]	getStatusValues()
InventoryStore	getStore()
Id	getStoreId()
Entity	getSupplier()
Id	getSupplierId()
SupplierInvoice	getSupplierInvoice()
SystemEntity	getSystemEntity()
Id	getSystemEntityId()
String	getTagPrefix()	Get the prefix of the tag to be used for generating the reference.
Money	getTotal()
int	getType()
String	getTypeValue()
static String[]	getTypeValues()
static void	indices(Indices indices)
boolean	isApplicable(LandedCostType landedCostType)	Is a specific type of landed cost applicable to this GRN?
boolean	isClosed()
boolean	isProcessed()
static String[]	links()
void	process(Transaction transaction)
static String[]	protectedColumns()
static String[]	searchColumns()
void	setCurrency(String currency)
void	setCurrencyObject(Currency currency)
void	setDate(Date date)
void	setExchangeRate(Rate exchangeRate)
void	setExchangeRate(Object value)
void	setInvoiceDate(Date invoiceDate)
void	setInvoiceNumber(String referenceNumber)
void	setLandedCost(Money landedCost)
void	setLandedCost(Object moneyValue)
void	setNo(int no)
void	setReferenceNumber(String referenceNumber)
void	setStatus(int status)
void	setStore(Id storeId)
void	setStore(InventoryStore store)
void	setStore(BigDecimal idValue)
void	setSupplier(Entity supplier)
void	setSupplier(Id supplierId)
void	setSupplier(BigDecimal idValue)
void	setType(int type)
String	toString()	String representation of the instance.
void	validateChildAttach(StoredObject child, int linkType)	Do validation when a child is attached.
void	validateChildUpdate(StoredObject child, int linkType)	Do validation when a child is updated.
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.
void	validateUpdate()	This method will be invoked whenever an existing instance is updated in 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, validate, validateChildDetach, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, valueEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.HasReference

getAmend, getTagSuffix, serialTag

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId, setSystemEntity

Methods inherited from interface com.storedobject.core.TriggerChangeEvent

changeCode

Constructor Details

InventoryGRN

public InventoryGRN()

Method Details

columns

public static void columns(Columns columns)

protectedColumns

public static String[] protectedColumns()

browseColumns

public static String[] browseColumns()

indices

public static void indices(Indices indices)

searchColumns

public static String[] searchColumns()

links

public static String[] links()

setNo

public void setNo(int no)

getNo

@SetNotAllowed
@Column(style="(serial)",
        order=10)
public int getNo()

Specified by:

getNo in interface HasReference

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface HasReference

Specified by:

getSystemEntity in interface OfEntity

getSystemEntityId

public Id getSystemEntityId()

Specified by:

getSystemEntityId in interface HasReference

Specified by:

getSystemEntityId in interface OfEntity

getReference

public String getReference()

Specified by:

getReference in interface HasReference

getTagPrefix

public String getTagPrefix()

Description copied from interface: HasReference

Get the prefix of the tag to be used for generating the reference.

Warning: This should be a fixed string value.

Specified by:

getTagPrefix in interface HasReference

Returns:

A fixed tag value to be used as the prefix.

setDate

@SetNotAllowed
public void setDate(Date date)

getDate

@Column(order=100,
        caption="Receipt Date")
public Date getDate()

Specified by:

getDate in interface HasReference

setReferenceNumber

public void setReferenceNumber(String referenceNumber)

getReferenceNumber

@Column(order=200,
        required=false,
        caption="Invoice Number")
public String getReferenceNumber()

setInvoiceNumber

public void setInvoiceNumber(String referenceNumber)

getInvoiceNumber

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

setInvoiceDate

public void setInvoiceDate(Date invoiceDate)

getInvoiceDate

@Column(order=300)
public Date getInvoiceDate()

setStore

public void setStore(Id storeId)

setStore

public void setStore(BigDecimal idValue)

setStore

public void setStore(InventoryStore store)

getStoreId

@SetNotAllowed
@Column(style="(any)",
        order=400)
public Id getStoreId()

getStore

public InventoryStore getStore()

setSupplier

public void setSupplier(Id supplierId)

setSupplier

public void setSupplier(BigDecimal idValue)

setSupplier

public void setSupplier(Entity supplier)

getSupplierId

@SetNotAllowed
@Column(order=500)
public Id getSupplierId()

getSupplier

public Entity getSupplier()

getStatusValues

public static String[] getStatusValues()

setStatus

public void setStatus(int status)

getStatus

@SetNotAllowed
@Column(order=600)
public int getStatus()

getStatusValue

public String getStatusValue()

getTypeValues

public static String[] getTypeValues()

setType

public void setType(int type)

getType

@SetNotAllowed
@Column(order=600)
public int getType()

getTypeValue

public String getTypeValue()

setLandedCost

public void setLandedCost(Money landedCost)

setLandedCost

public void setLandedCost(Object moneyValue)

getLandedCost

@SetNotAllowed
@Column(order=700)
public Money getLandedCost()

setCurrency

public void setCurrency(String currency)

getCurrency

@SetNotAllowed
@Column(order=800,
        style="(currency)",
        caption="Original Currency")
public String getCurrency()

setCurrencyObject

public void setCurrencyObject(Currency currency)

getCurrencyObject

public Currency getCurrencyObject()

setExchangeRate

public void setExchangeRate(Rate exchangeRate)

setExchangeRate

public void setExchangeRate(Object value)

getExchangeRate

@SetNotAllowed
@Column(order=900)
public Rate getExchangeRate()

isProcessed

public boolean isProcessed()

isClosed

public boolean isClosed()

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.

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.

validateUpdate

public void validateUpdate()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is updated in 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 updated in the database.

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

Also, see StoredObject.validate().

Overrides:

validateUpdate in class StoredObject

Throws:

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

validateChildAttach

public void validateChildAttach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is attached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildAttach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

validateChildUpdate

public void validateChildUpdate(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is updated. Default implementation of this invokes StoredObject.validateChildAttach(StoredObject, int).

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildUpdate in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

getSupplierInvoice

public SupplierInvoice getSupplierInvoice()

process

public void process(Transaction transaction)
             throws Exception

Throws:

Exception

close

public void close(Transaction transaction)
           throws Exception

Throws:

Exception

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.

isApplicable

public boolean isApplicable(LandedCostType landedCostType)

Is a specific type of landed cost applicable to this GRN?

Parameters:

landedCostType - Type of landed cost.

Returns:

True/false.

computeLandedCost

public void computeLandedCost(TransactionManager tm)
                       throws Exception

Compute/recompute the landed cost.

Parameters:

tm - Transaction manager.

Throws:

Exception - If any error occurs.

getAmount

public Money getAmount()

getTotal

public Money getTotal()

computeTax

public void computeTax(TransactionManager tm,
 TaxRegion region)
                throws Exception

Throws:

Exception

actionPrefixForUI

public static String actionPrefixForUI()

correctExchangeRate

public void correctExchangeRate(Transaction transaction,
 Rate exchangeRate)
                         throws Exception

Throws:

Exception