com.dns

Class ProductItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Task.JobItem

com.aspc.Layers.aspc_app.Task.ProductItem

com.dns.ProductItem

All Implemented Interfaces:

SecondaryCacheGroup

public class ProductItem
extends ProductItem

Products to add.

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

Since:

$Date: 2011-05-20 06:10:28 $

Author:

Liam

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 java.lang.String	PRICE_TYPE_BEST best price
static java.lang.String	PRICE_TYPE_NORMAL normal price
static java.lang.String	PRICE_TYPE_QUOTE quote price

Fields inherited from class com.aspc.Layers.aspc_app.Task.ProductItem

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
ProductItem(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
double	calculatePrice(double price, java.lang.String reportType) Performs additional validations on this record.
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 void	extDelete() touch the assoicated event so that we can update the concrete fields.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) OVERRIDE This method to filter ALL public calls to SetValue.
protected void	extUpdateUnitPrice() 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
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
BuildingSize	findBuildingSize(java.lang.String... args) Building size.
BuildingSize	findCalcBuildSize(java.lang.String... args) Calculated building size.
PriceType	findPriceType(java.lang.String... args) Price Type.
java.lang.Object	findPriority(java.lang.String... args) Priority.
protected static java.lang.Double	findSpecialPrice(DataSource ds, DBObject customer, Product prod, java.lang.String reportType, java.lang.String calcSize)
BuildingSize	getBuildingSize(java.lang.String... args)
BuildingSize	getCalcBuildSize(java.lang.String... args)
PriceType	getPriceType(java.lang.String... args)
java.lang.Object	getPriority(java.lang.String... args)
java.lang.String	getProvider(java.lang.String... args)
boolean	hasPurchase(java.lang.String... args)
boolean	isBuildPestReport(java.lang.String... args)
boolean	isFromBuildingPestReport(java.lang.String... args)
ProductItem	setBuildingSize(com.dns.dal.BuildingSize value, java.lang.String... args)
ProductItem	setBuildPestReport(boolean value, java.lang.String... args)
ProductItem	setFromBuildingPestReport(boolean value, java.lang.String... args)
ProductItem	setPriceType(com.dns.dal.PriceType value, java.lang.String... args)
ProductItem	setPriority(java.lang.Object value, java.lang.String... args)

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

extCheckModifyAccess, extFixUp, extIsOnChange, findInventoryAdjustmentType, findInvoiceItem, findNextDeliverySchedule, findPicture, findProductID, findStockBinItem, getAdjNumDeliveries, getCalcNumDeliveries, getDeliveriesMade, getDeliveriesRemaining, getInventoryAdjustmentType, getInventoryAmountAdjusted, getInventoryQtyAdjusted, getInventoryQtyCommitted, getInvoice, getInvoiceItem, getLastDelivered, getNextDeliverySchedule, getNumDeliveries, getPicture, getProductID, getQtyOutstanding, getStockBinItem, getTotalQtyDelivered, getType, isInvoiceLocked, setAdjNumDeliveries, setInvoiceItem, setNumDeliveries, setPicture, setProductID, setStockBinItem, setType, updateUnitPrice

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

extCheckCreateAccess, extCheckModifyAccess, extCheckReadAccess, extPreValidate, extValidateField, findChargableTaskID, findGroupItem, getAdjTotalCostExcludingTax, getCalcTotalCostExcludingTax, getChargableTaskID, getChargeTask, getGroupItem, getTotalCostExcludingTax, getUnitCostExcludingTax, isOrderFromSupplier, setAdjTotalCostExcludingTax, setChargableTaskID, setGroupItem, setOrderFromSupplier, setUnitCostExcludingTax

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

copyIncludeField, extCopy, 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, extCheckDeleteAccess, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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

PRICE_TYPE_NORMAL

public static final java.lang.String PRICE_TYPE_NORMAL

normal price

See Also:

Constant Field Values

PRICE_TYPE_QUOTE

public static final java.lang.String PRICE_TYPE_QUOTE

quote price

See Also:

Constant Field Values

PRICE_TYPE_BEST

public static final java.lang.String PRICE_TYPE_BEST

best price

See Also:

Constant Field Values

Constructor Detail

ProductItem

public ProductItem(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 ProductItem setBuildingSize(com.dns.dal.BuildingSize value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getCalcBuildSize

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

findCalcBuildSize

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

Calculated building size.

--> BuildingSize (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

BuildingSize

Throws:

NotFoundException - BuildingSize was not found

isFromBuildingPestReport

@CheckReturnValue
public boolean isFromBuildingPestReport(java.lang.String... args)

setFromBuildingPestReport

@Nonnull
public ProductItem setFromBuildingPestReport(boolean value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

hasPurchase

@CheckReturnValue
public boolean hasPurchase(java.lang.String... args)

isBuildPestReport

@CheckReturnValue
public boolean isBuildPestReport(java.lang.String... args)

setBuildPestReport

@Nonnull
public ProductItem setBuildPestReport(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getPriceType

@CheckReturnValue
 @Nullable
public PriceType getPriceType(java.lang.String... args)

findPriceType

@CheckReturnValue
 @Nonnull
public final PriceType findPriceType(java.lang.String... args)
                                                          throws NotFoundException

Price Type.

--> PriceType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceType

Throws:

NotFoundException - PriceType was not found

setPriceType

@Nonnull
public ProductItem setPriceType(com.dns.dal.PriceType value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getPriority

@CheckReturnValue
 @Nullable
public java.lang.Object getPriority(java.lang.String... args)

findPriority

@CheckReturnValue
 @Nonnull
public final java.lang.Object findPriority(java.lang.String... args)
                                                                throws NotFoundException

Priority.

--> Priority (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Priority

Throws:

NotFoundException - Priority was not found

setPriority

@Nonnull
public ProductItem setPriority(java.lang.Object value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getProvider

@CheckReturnValue
 @Nonnull
public java.lang.String getProvider(java.lang.String... args)

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

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class ProductItem

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A 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

update dependent fields.

Overrides:

eventFieldUpdated in class ProductItem

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

extUpdateUnitPrice

protected void extUpdateUnitPrice()
                           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

Overrides:

extUpdateUnitPrice in class ProductItem

Throws:

java.lang.Exception - a serious problem

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

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class ProductItem

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

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 ProductItem

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

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - Exception A serious problem

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

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

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

calculatePrice

public double calculatePrice(double price,
                             java.lang.String reportType)

Performs additional validations on this record. Only ever called from MutableDataSource.

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extDelete

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

touch the assoicated event so that we can update the concrete fields.

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

findSpecialPrice

protected static java.lang.Double findSpecialPrice(DataSource ds,
                                                   DBObject customer,
                                                   Product prod,
                                                   java.lang.String reportType,
                                                   java.lang.String calcSize)
                                            throws java.lang.Exception

Throws:

java.lang.Exception