com.dns

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

com.dns.PurchaseProductItem

All Implemented Interfaces:

SecondaryCacheGroup

public class PurchaseProductItem
extends PurchaseProductItem

Generic DBObject.

Notes

Details of individual items purchased


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

Since:

$Date: 2010-07-08 00:19:45 $

Author:

Liam

Nested Class Summary

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

DBObject.DenormalizeAction

Field Summary

Fields inherited from class com.aspc.Layers.aspc_app.Purchase.PurchaseProductItem

DBCLASS_GID, DBCLASS_NAME

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 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	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) OVERRIDE This method to filter ALL public calls to SetValue.
BuildingSize	findBuildingSize(java.lang.String... args) Building Size.
Product	findSupplierProduct(java.lang.String... args) Supplier Product.
BuildingSize	getBuildingSize(java.lang.String... args)
double	getCalculatedPrice(java.lang.String... args)
double	getProfit(java.lang.String... args)
Product	getSupplierProduct(java.lang.String... args)
PurchaseProductItem	setBuildingSize(com.dns.dal.BuildingSize value, java.lang.String... args)
PurchaseProductItem	setSupplierProduct(com.dns.dal.Product value, java.lang.String... args)
protected void	updateUnitPrice(double price) Handles the generation of the unit price based on the attributes selected The unit price is retreived from the p rice matrix that matches the selection In cases where their is no price matrix then the price is set to zero which means that it must be manually overridden

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

eventFieldUpdated, extAutoEnterCreate, extPreValidate, extValidateField, findInventoryAdjustmentType, findProduct, findStockBinItem, getBackorder, getInventoryAdjustmentType, getInventoryAmountAdjusted, getInventoryQtyAdjusted, getInventoryQtyCommitted, getItemsRemaining, getProduct, getReceived, getStockBinItem, setBackorder, setProduct, setReceived, setStockBinItem

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, 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

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

getBuildingSize

@CheckReturnValue
 @Nullable
public BuildingSize getBuildingSize(java.lang.String... args)

findBuildingSize

@CheckReturnValue
 @Nonnull
public final BuildingSize findBuildingSize(java.lang.String... args)
                                                                throws NotFoundException

Building Size.

--> BuildingSize (String, Searchable)

Parameters:

args - the optional arguments

Returns:

BuildingSize

Throws:

NotFoundException - BuildingSize was not found

setBuildingSize

@Nonnull
public PurchaseProductItem setBuildingSize(com.dns.dal.BuildingSize value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getCalculatedPrice

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

getProfit

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

getSupplierProduct

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

findSupplierProduct

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

Supplier Product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setSupplierProduct

@Nonnull
public PurchaseProductItem setSupplierProduct(com.dns.dal.Product value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to filter ALL public calls to SetValue. This method is called BEFORE the field is changed.

You can use this method to implement things like composite keys where the key value is made up of two or more other fields. So when field1 or field2 is updated we call iSetValue to change the key value and in extSetValue we ignore any value set by the user/screen for the key field.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field

currentValue -

params - the field parameters

Throws:

java.lang.Exception - Exception A serious problem

updateUnitPrice

protected void updateUnitPrice(double price)
                        throws java.lang.Exception

Handles the generation of the unit price based on the attributes selected The unit price is retreived from the p rice matrix that matches the selection In cases where their is no price matrix then the price is set to zero which means that it must be manually overridden

Throws:

java.lang.Exception - a serious problem

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 PurchaseProductItem

Parameters:

field - The field

Returns:

the value

extGetDerivedValue

@CheckReturnValue
 @Nullable
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 PurchaseProductItem

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