com.aspc.Layers.aspc_app.Purchase

Class PurchaseProductItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Purchase.PurchaseItem

com.aspc.Layers.aspc_app.Purchase.PurchaseProductItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

PurchaseProductItem, PurchaseProductItem

public class PurchaseProductItem
extends PurchaseItem

PurchaseProductItem Generic DBObject.

Notes

Details of individual items purchased


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

Since:

November 10 2003

Author:

Jason McGrath

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 PurchaseProductItem
static java.lang.String	DBCLASS_NAME PurchaseProductItem

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
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.
Product	findProduct(java.lang.String... args) Item number for the selected product.
StockBinItem	findStockBinItem(java.lang.String... args) If product is inventoried then the Stock Item identifies the location that it is monitored.
double	getBackorder(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)
double	getItemsRemaining(java.lang.String... args)
Product	getProduct(java.lang.String... args)
double	getReceived(java.lang.String... args)
StockBinItem	getStockBinItem(java.lang.String... args)
PurchaseProductItem	setBackorder(double value, java.lang.String... args)
PurchaseProductItem	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
PurchaseProductItem	setReceived(double value, java.lang.String... args)
PurchaseProductItem	setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.Purchase.PurchaseItem

extCheckModifyAccess, extCheckReadAccess, extPreSaveRecord, findChargeitem, findInvoiceId, findInvoiceItemId, findJob, findPurchaseId, findSupplierQuoteItem, getChargeitem, getInvoiceId, getInvoiceItemId, getJob, getPurchase, getPurchaseId, getSupplierQuoteItem, isModifiableWhenLocked, setChargeitem, setInvoiceId, setInvoiceItemId, setJob, setPurchaseId, setSupplierQuoteItem

Methods inherited from class com.aspc.Layers.aspc_app.Task.ChargeItem

copyIncludeField, extCopy, extFixUp, extIsMandatory, findAccount, findAdjPriceCheckedBy, findAdjPriceReason, findCalcPriceMatrix, findChargeItemStatus, findChargeItemType, findEnteredBy, findExportFg, findKey, findOwnerBusUnit, findRecurringBase, findTaxCodeId, getAccount, getAdjPriceCheckedBy, getAdjPriceCheckedNotes, getAdjPriceReason, getAdjPriceReasonNotes, getAdjTotalPrice, getAdjTotalPriceIncludingTax, getAdjUnitPrice, getAdjUnitPriceExcludingTax, getAdjUnitPriceIncludingTax, getBackOrdered, getCalcPriceMatrix, getCalcUnitPriceExcludingTax, getChargeItemStatus, getChargeItemType, getCode, getDescription, getDiscountRate, getEnteredBy, getEnteredTime, getExportedTime, getExportFg, getID, getItemCode, getMyobImportTime, getNotes, getOrdered, getOwnerBusUnit, getQty, getRecurringBase, getRoyalties, getTaxCodeId, getTaxRate, getTotalDiscount, getTotalPriceExcludingTax, getTotalPriceIncludingTax, getTotalRoyalties, getTotalTax, getUnitMeasure, getUnitPrice, getUnitPriceDisplay, getUnitPriceDisplayExcludingTax, getUnitPriceDisplayIncludingTax, getUnitPriceExcludingTax, getUnitPriceIncludingTax, hasReadAccess, isAdjPriceChecked, isAdjPriceReasonRequired, isAdjTotalPriceIncludesTax, isAdjUnitPriceIncludesTax, isAdjustItem, isMonthlyRecurring, isNeedToBeCloned, isUnitPriceIncludesTax, makeQuery, setAccount, setAdjPriceChecked, setAdjPriceCheckedBy, setAdjPriceCheckedNotes, setAdjPriceReason, setAdjPriceReasonNotes, setAdjPriceReasonRequired, setAdjTotalPrice, setAdjTotalPriceIncludesTax, setAdjTotalPriceIncludingTax, setAdjUnitPrice, setAdjUnitPriceIncludesTax, setAdjustItem, setBackOrdered, setChargeItemStatus, setCode, setDescription, setDiscountRate, setEnteredBy, setEnteredTime, setExportedTime, setExportFg, setID, setItemCode, setMonthlyRecurring, setMyobImportTime, setNotes, setOrdered, setOwnerBusUnit, setQty, setRecurringBase, setTaxCodeId, setTaxRate, setUnitMeasure, setUnitPrice, setUnitPriceExcludingTax, setUnitPriceIncludesTax, setUnitPriceIncludingTax

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, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

PurchaseProductItem

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

PurchaseProductItem

Constructor Detail

PurchaseProductItem

public PurchaseProductItem(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

getBackorder

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

setBackorder

@Nonnull
public PurchaseProductItem setBackorder(double 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)

getItemsRemaining

@CheckReturnValue
public double getItemsRemaining(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

Item number for the selected product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

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

Throws:

java.lang.Exception

getReceived

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

setReceived

@Nonnull
public PurchaseProductItem setReceived(double 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 PurchaseProductItem setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class ChargeItem

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: PurchaseItem

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class PurchaseItem

Parameters:

field - The field

Returns:

the value

eventFieldUpdated

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

update dependent fields.

Overrides:

eventFieldUpdated in class PurchaseItem

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

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 PurchaseItem

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

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class ChargeItem

Throws:

java.lang.Exception - A serious problem