com.aspc.Layers.aspc_app.Inventory

Class StockReceiptItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Inventory.StockReceiptItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

StockReceiptItem

public class StockReceiptItem
extends DBObject

Stock Receipt Item.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

October 24, 2006, 10:47 PM

Author:

Aloysius George

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Stock Receipt Item
static java.lang.String	DBCLASS_NAME Stock Receipt Item

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
StockReceiptItem(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static StockReceiptItem	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreDeleteRecord() Update the in-memory universe BEFORE deleting
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
InventoryAdjustmentItemType	findInventoryAdjustmentType(java.lang.String... args) Identifies the type of adjustment.
static StockReceiptItem	findKey(DataSource ds, int key) Find the target for this class by the primary key
Product	findProduct(java.lang.String... args) product field.
PurchaseItem	findPurchaseOrderItem(java.lang.String... args) Purchase Order Item.
StockBin	findStockBin(java.lang.String... args) linked stock bin.
StockBinItem	findStockBinItem(java.lang.String... args) If product is inventoried then the Stock Item identifies the location that it is monitored.
StockReceipt	findStockReceipt(java.lang.String... args) Stock Receipt.
int	getID(java.lang.String... args)
InventoryAdjustmentItemType	getInventoryAdjustmentType(java.lang.String... args)
double	getInventoryAmountAdjusted(java.lang.String... args)
double	getInventoryQtyAdjusted(java.lang.String... args)
double	getInventoryQtyCommitted(java.lang.String... args)
Product	getProduct(java.lang.String... args)
PurchaseItem	getPurchaseOrderItem(java.lang.String... args)
double	getQty(java.lang.String... args)
StockBin	getStockBin(java.lang.String... args)
StockBinItem	getStockBinItem(java.lang.String... args)
StockReceipt	getStockReceipt(java.lang.String... args)
static DBQuery<StockReceiptItem>	makeQuery(DataSource ds) Make a new QUERY for this class.
StockReceiptItem	setID(int value, java.lang.String... args)
StockReceiptItem	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
StockReceiptItem	setPurchaseOrderItem(com.aspc.dal.layers.aspc_app.purchase.PurchaseItem value, java.lang.String... args)
StockReceiptItem	setQty(double value, java.lang.String... args)
StockReceiptItem	setStockBin(com.aspc.dal.layers.aspc_app.inventory.StockBin value, java.lang.String... args)
StockReceiptItem	setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value, java.lang.String... args)
StockReceiptItem	setStockReceipt(com.aspc.dal.layers.aspc_app.inventory.StockReceipt value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Stock Receipt Item

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Stock Receipt Item

Constructor Detail

StockReceiptItem

public StockReceiptItem(DBClass def,
                        DataSource dataSource)
                 throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public StockReceiptItem setID(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getInventoryAdjustmentType

@CheckReturnValue
 @Nullable
public InventoryAdjustmentItemType getInventoryAdjustmentType(java.lang.String... args)

findInventoryAdjustmentType

@CheckReturnValue
 @Nonnull
public final InventoryAdjustmentItemType findInventoryAdjustmentType(java.lang.String... args)
                                                                                          throws NotFoundException

Identifies the type of adjustment.

--> .InventoryAdjustmentItemType InventoryAdjustmentItemType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

InventoryAdjustmentItemType

Throws:

NotFoundException - InventoryAdjustmentItemType was not found

getInventoryAmountAdjusted

@CheckReturnValue
public double getInventoryAmountAdjusted(java.lang.String... args)

getInventoryQtyAdjusted

@CheckReturnValue
public double getInventoryQtyAdjusted(java.lang.String... args)

getInventoryQtyCommitted

@CheckReturnValue
public double getInventoryQtyCommitted(java.lang.String... args)

getProduct

@CheckReturnValue
 @Nullable
public Product getProduct(java.lang.String... args)

findProduct

@CheckReturnValue
 @Nonnull
public final Product findProduct(java.lang.String... args)
                                                      throws NotFoundException

product field.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

@Nonnull
public StockReceiptItem setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getPurchaseOrderItem

@CheckReturnValue
 @Nullable
public PurchaseItem getPurchaseOrderItem(java.lang.String... args)

findPurchaseOrderItem

@CheckReturnValue
 @Nonnull
public final PurchaseItem findPurchaseOrderItem(java.lang.String... args)
                                                                     throws NotFoundException

Purchase Order Item.

--> PurchaseItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

PurchaseItem

Throws:

NotFoundException - PurchaseItem was not found

setPurchaseOrderItem

@Nonnull
public StockReceiptItem setPurchaseOrderItem(com.aspc.dal.layers.aspc_app.purchase.PurchaseItem value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getQty

@CheckReturnValue
public double getQty(java.lang.String... args)

setQty

@Nonnull
public StockReceiptItem setQty(double value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getStockBin

@CheckReturnValue
 @Nullable
public StockBin getStockBin(java.lang.String... args)

findStockBin

@CheckReturnValue
 @Nonnull
public final StockBin findStockBin(java.lang.String... args)
                                                        throws NotFoundException

linked stock bin.

--> StockBin (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

StockBin

Throws:

NotFoundException - StockBin was not found

setStockBin

@Nonnull
public StockReceiptItem setStockBin(com.aspc.dal.layers.aspc_app.inventory.StockBin value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getStockBinItem

@CheckReturnValue
 @Nullable
public StockBinItem getStockBinItem(java.lang.String... args)

findStockBinItem

@CheckReturnValue
 @Nonnull
public final StockBinItem findStockBinItem(java.lang.String... args)
                                                                throws NotFoundException

If product is inventoried then the Stock Item identifies the location that it is monitored.

--> StockBinItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

StockBinItem

Throws:

NotFoundException - StockBinItem was not found

setStockBinItem

@Nonnull
public StockReceiptItem setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getStockReceipt

@CheckReturnValue
 @Nullable
public StockReceipt getStockReceipt(java.lang.String... args)

findStockReceipt

@CheckReturnValue
 @Nonnull
public final StockReceipt findStockReceipt(java.lang.String... args)
                                                                throws NotFoundException

Stock Receipt.

--> StockReceipt (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

StockReceipt

Throws:

NotFoundException - StockReceipt was not found

setStockReceipt

@Nonnull
public StockReceiptItem setStockReceipt(com.aspc.dal.layers.aspc_app.inventory.StockReceipt value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static StockReceiptItem create(@Nonnull
                                                                  MutableDataSource mds)
                                                           throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<StockReceiptItem> makeQuery(@Nonnull
                                                                              DataSource ds)
                                                                       throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static StockReceiptItem findKey(@Nonnull
                                                                   DataSource ds,
                                                                   int key)
                                                            throws NotFoundException,
                                                                   java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A serious problem

extPreDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPreDeleteRecord()
                                                             throws java.lang.Exception

Update the in-memory universe BEFORE deleting

Overrides:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - Serious Problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - A serious problem

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem