com.aspc.Layers.aspc_app.Task

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

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ProductItem, ProductItem

public class ProductItem
extends JobItem

SDBJobItem is a Products to add.

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

Since:

May 11, 2001, 3:11 PM

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 Products to add
static java.lang.String	DBCLASS_NAME Products to add

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
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extFixUp() The extended fix up routine for known problems.
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 boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extUpdateUnitPrice()
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
InventoryAdjustmentItemType	findInventoryAdjustmentType(java.lang.String... args) Identifies the type of adjustment.
InvoiceItem	findInvoiceItem(java.lang.String... args) Links to the invoice, if this item has been invoiced.
DeliverySchedule	findNextDeliverySchedule(java.lang.String... args) Next Publication.
DBFile	findPicture(java.lang.String... args) A picture of the product.
Product	findProductID(java.lang.String... args) Select the product.
StockBinItem	findStockBinItem(java.lang.String... args) If product is inventoried then the Stock Item identifies the location that it is monitored.
int	getAdjNumDeliveries(java.lang.String... args)
int	getCalcNumDeliveries(java.lang.String... args)
int	getDeliveriesMade(java.lang.String... args)
int	getDeliveriesRemaining(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)
Invoice	getInvoice()
InvoiceItem	getInvoiceItem(java.lang.String... args)
java.util.Date	getLastDelivered(java.lang.String... args)
DeliverySchedule	getNextDeliverySchedule(java.lang.String... args)
int	getNumDeliveries(java.lang.String... args)
DBFile	getPicture(java.lang.String... args)
Product	getProductID(java.lang.String... args)
double	getQtyOutstanding(java.lang.String... args)
StockBinItem	getStockBinItem(java.lang.String... args)
double	getTotalQtyDelivered(java.lang.String... args)
java.lang.String	getType(java.lang.String... args)
boolean	isInvoiceLocked()
ProductItem	setAdjNumDeliveries(int value, java.lang.String... args)
ProductItem	setInvoiceItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceItem value, java.lang.String... args)
ProductItem	setNumDeliveries(int value, java.lang.String... args)
ProductItem	setPicture(com.aspc.dal.file.DBFile value, java.lang.String... args)
ProductItem	setProductID(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
ProductItem	setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value, java.lang.String... args)
ProductItem	setType(java.lang.String value, java.lang.String... args)
void	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, extAutoEnterCreate, 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, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, 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

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Products to add

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Products to add

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

getAdjNumDeliveries

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

setAdjNumDeliveries

@Nonnull
public ProductItem setAdjNumDeliveries(int value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getCalcNumDeliveries

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

getDeliveriesMade

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

getDeliveriesRemaining

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

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)

getInvoiceItem

@CheckReturnValue
 @Nullable
public InvoiceItem getInvoiceItem(java.lang.String... args)

findInvoiceItem

@CheckReturnValue
 @Nonnull
public final InvoiceItem findInvoiceItem(java.lang.String... args)
                                                              throws NotFoundException

Links to the invoice, if this item has been invoiced.

--> InvoiceItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceItem

Throws:

NotFoundException - InvoiceItem was not found

setInvoiceItem

@Nonnull
public ProductItem setInvoiceItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceItem value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getLastDelivered

@CheckReturnValue
 @Nullable
public java.util.Date getLastDelivered(java.lang.String... args)

getNextDeliverySchedule

@CheckReturnValue
 @Nullable
public DeliverySchedule getNextDeliverySchedule(java.lang.String... args)

findNextDeliverySchedule

@CheckReturnValue
 @Nonnull
public final DeliverySchedule findNextDeliverySchedule(java.lang.String... args)
                                                                            throws NotFoundException

Next Publication.

--> DeliverySchedule (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliverySchedule

Throws:

NotFoundException - DeliverySchedule was not found

getNumDeliveries

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

setNumDeliveries

@Nonnull
public ProductItem setNumDeliveries(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getPicture

@CheckReturnValue
 @Nullable
public DBFile getPicture(java.lang.String... args)

findPicture

@CheckReturnValue
 @Nonnull
public final DBFile findPicture(java.lang.String... args)
                                                     throws NotFoundException

A picture of the product.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setPicture

@Nonnull
public ProductItem setPicture(com.aspc.dal.file.DBFile value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getProductID

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

findProductID

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

Select the product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProductID

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

Throws:

java.lang.Exception

getQtyOutstanding

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

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 ProductItem setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getTotalQtyDelivered

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

getType

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

setType

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

Throws:

java.lang.Exception

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class JobItem

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

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 JobItem

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

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 DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

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

Overrides:

extIsOnChange in class ChargeItem

Parameters:

field - The field

Returns:

the value

updateUnitPrice

public final void updateUnitPrice()
                           throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

extUpdateUnitPrice

protected void extUpdateUnitPrice()
                           throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify

isInvoiceLocked

public boolean isInvoiceLocked()

Returns:

the value

getInvoice

public Invoice getInvoice()

Returns:

the value

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 ChargeItem

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

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class JobItem

Throws:

java.lang.Exception - A serious problem