Package com.storedobject.core

Class InventoryStore

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryStore

All Implemented Interfaces:

Displayable, StringFiller, HasId, OfEntity

public class InventoryStore
extends StoredObject
implements OfEntity

Represents a store where items can stocked at the bin locations (InventoryBin) of the store.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryStore()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static String[]	displayColumns()
InventoryBin	findBin(InventoryItem item)	Find a suitable "bin" in this store for the specified item.
InventoryBin	findBin(InventoryItemType partNumber)	Find a suitable "bin" in this store for the specified part number.
static <T extends InventoryStore> T	get(SystemEntity systemEntity, String name)
String	getName()
boolean	getRepairable()
static InventoryStore	getStore(Id id)
final InventoryStoreBin	getStoreBin()
SystemEntity	getSystemEntity()
Id	getSystemEntityId()
String	getUniqueCondition()	Gets the unique index condition of this object.
static int	hints()
static void	indices(Indices indices)
boolean	isRepairable()	If items stored in this store are repairable or not.
static <T extends InventoryStore> ObjectIterator<T>	list(SystemEntity systemEntity, String name)
void	setName(String name)
void	setSystemEntity(Id systemEntityId)
void	setSystemEntity(SystemEntity systemEntity)
void	setSystemEntity(BigDecimal idValue)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.
void	validateInsert()	This method will be invoked whenever a new instance is saved to 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, 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, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, 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.OfEntity

check, findSystemEntityId

Constructor Details

InventoryStore

public InventoryStore()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

hints

public static int hints()

displayColumns

public static String[] displayColumns()

getName

@Column(order=200)
public String getName()

setName

public void setName(String name)

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Specified by:

setSystemEntity in interface OfEntity

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

getSystemEntityId

@SetNotAllowed
@Column(order=100,
        caption="Of")
public Id getSystemEntityId()

Specified by:

getSystemEntityId in interface OfEntity

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface OfEntity

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.

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.

validateInsert

public void validateInsert()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever a new instance is saved to the database. So, it will be called within an active transaction. Child classes can override this method to do validation when a newly created instance is saved to the database.

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

Also, see StoredObject.validate().

Overrides:

validateInsert in class StoredObject

Throws:

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

get

public static <T extends InventoryStore> T get(SystemEntity systemEntity,
 String name)

list

public static <T extends InventoryStore>
ObjectIterator<T> list(SystemEntity systemEntity,
 String name)

getStoreBin

public final InventoryStoreBin getStoreBin()

getStore

public static InventoryStore getStore(Id id)

isRepairable

public boolean isRepairable()

If items stored in this store are repairable or not. Typically, if it is a scrap store, items are not repairable.

Returns:

True/false. Default is "true".

getRepairable

public boolean getRepairable()

findBin

public InventoryBin findBin(InventoryItemType partNumber)

Find a suitable "bin" in this store for the specified part number.

Parameters:

partNumber - Part Number.

Returns:

Bin from historical data. Could be null. If multiple bins exist, one will be returned.

findBin

public InventoryBin findBin(InventoryItem item)

Find a suitable "bin" in this store for the specified item.

Parameters:

item - Item.

Returns:

Bin from historical data. Could be null. If multiple bins exist, one will be returned.