Package com.storedobject.core

Class InventoryPO

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryPO

All Implemented Interfaces:

Displayable, StringFiller, HasChildren, HasId, HasReference, TradeType

@Table(anchors="Store")
public class InventoryPO
extends StoredObject
implements HasChildren, HasReference, TradeType

Base class for creating Purchase Orders (POs). This class may be used as such, or it can be extended to add more fields if required. It may also be used for other type of orders such as "Loan Orders" etc. and in such cases, the appropriate GRN type (getGRNType()) should be returned.

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
InventoryPO()

Method Summary

Modifier and Type	Method	Description
static String	actionPrefixForUI()
Id	amendOrder(Transaction transaction)	Amend this PO.
static String[]	browseColumns()
boolean	canClose()
boolean	canForeclose()
void	closeOrder(Transaction transaction)
static void	columns(Columns columns)
InventoryGRN	createGRN(Transaction transaction, Map<Id,Quantity> quantities, InventoryGRN grn, String invoiceNumber, Date invoiceDate)	Create a GRN for this PO.
final <O extends StoredObject> HasReference.Amend<O>	getAmend()
boolean	getApprovalRequired()
Date	getDate()
int	getGRNType()	Get the GRN type.
int	getNo()
final String	getReference()
String	getReferenceNumber()	Deprecated.
int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
InventoryStore	getStore()
Id	getStoreId()
Entity	getSupplier()
Id	getSupplierId()
SystemEntity	getSystemEntity()
String	getTagPrefix()	Get the prefix of the tag to be used for generating the reference.
static void	indices(Indices indices)
boolean	isApplicable(LandedCostType landedCostType, InventoryGRN grn)	Is a specific type of landed cost is applicable to this PO?
boolean	isClosed()
static String[]	links()
final ObjectIterator<InventoryPOItem>	listItems()
void	placeOrder(Transaction transaction)
static String[]	protectedColumns()
void	recallOrder(Transaction transaction)
static String[]	searchColumns()
void	setApprovalRequired(boolean approvalRequired)
void	setDate(Date date)
void	setNo(int no)
void	setReferenceNumber(String referenceNumber)	Deprecated.
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)
String	toDisplay()	Display representation of the instance used for human-friendly display.
void	validate()	This method is invoked internally by the system whenever the object gets saved to the DB (that means, while doing transactions).
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)	This will be invoked by the system 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, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, 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, 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, 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, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toString, transacting, undelete, undelete, undeleted, updated, user, userId, 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

getSystemEntityId, getTagSuffix, serialTag

Methods inherited from interface com.storedobject.core.TradeType

getType

Constructor Details

InventoryPO

public InventoryPO()

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

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.

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface HasReference

getReference

public final String getReference()

Specified by:

getReference in interface HasReference

setDate

public void setDate(Date date)

getDate

@Column(order=100)
public Date getDate()

Specified by:

getDate in interface HasReference

setReferenceNumber

@Deprecated
public void setReferenceNumber(String referenceNumber)

Deprecated.

getReferenceNumber

@Deprecated
@Column(order=200,
        required=false,
        caption="Other Reference")
public String getReferenceNumber()

Deprecated.

setStore

public void setStore(Id storeId)

setStore

public void setStore(BigDecimal idValue)

setStore

public void setStore(InventoryStore store)

getStoreId

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

@Column(order=400)
public Id getSupplierId()

getSupplier

public Entity getSupplier()

getStatusValues

public static String[] getStatusValues()

setStatus

public void setStatus(int status)

getStatus

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

getStatusValue

public String getStatusValue()

getStatusValue

public static String getStatusValue(int value)

setApprovalRequired

public void setApprovalRequired(boolean approvalRequired)

getApprovalRequired

@Column(order=800,
        required=false)
public boolean getApprovalRequired()

isClosed

public boolean isClosed()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting 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

This method is invoked internally by the system 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/un-deleting 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 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 method 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.

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.

amendOrder

public Id amendOrder(Transaction transaction)
              throws Exception

Amend this PO. This PO will be foreclosed and another PO will be created with the balance items to receive.

Parameters:

transaction - Transaction.

Returns:

The id of the newly created (and saved) PO with balance items to receive.

Throws:

Exception - If any exception occurs while carrying out the transaction.

recallOrder

public void recallOrder(Transaction transaction)
                 throws Exception

Throws:

Exception

placeOrder

public void placeOrder(Transaction transaction)
                throws Exception

Throws:

Exception

closeOrder

public void closeOrder(Transaction transaction)
                throws Exception

Throws:

Exception

canClose

public boolean canClose()

canForeclose

public boolean canForeclose()

createGRN

public InventoryGRN createGRN(Transaction transaction,
 Map<Id,Quantity> quantities,
 InventoryGRN grn,
 String invoiceNumber,
 Date invoiceDate)
                       throws Exception

Create a GRN for this PO.

Parameters:

transaction - Current transaction.

quantities - Received quantity values to process. The Id (key of the map) must the Id of the respective line item entry in the PO.

grn - A GRN to which the entries to be added. If null is passed, a new GRN is created.

invoiceNumber - Invoice number (of the supplier) if applicable. For existing GRNs, null could be passed.

invoiceDate - Invoice date (of the supplier) if applicable. For existing GRNs, null could be passed.

Returns:

The GRN that is created/modified.

Throws:

Exception - If the GRN can't be created.

listItems

public final ObjectIterator<InventoryPOItem> listItems()

getGRNType

public int getGRNType()

Get the GRN type. One of the GRN type values: 0, 1 or 2.

Returns:

Type of GRN. Default is 0.

isApplicable

public boolean isApplicable(LandedCostType landedCostType,
 InventoryGRN grn)

Is a specific type of landed cost is applicable to this PO?

Parameters:

landedCostType - Type of landed cost.

grn - Associated GRN.

Returns:

True/false.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

getAmend

public final <O extends StoredObject>
HasReference.Amend<O> getAmend()

Specified by:

getAmend in interface HasReference

actionPrefixForUI

public static String actionPrefixForUI()