com.aspc.Layers.aspc_app.Invoice

Class ProductPartBreakDown

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.ProductPartBreakDown

All Implemented Interfaces:

SecondaryCacheGroup

public class ProductPartBreakDown
extends DBObject

holds a record of when which product was taken for a part order.

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

Since:

October 22, 2003, 9:41 AM

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 holds a record of when which product was taken for a part order
static java.lang.String	DBCLASS_NAME holds a record of when which product was taken for a part order

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ProductPartBreakDown	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 void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckReadAccess() Additional access checking for READ access of this object.
protected void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
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	extPreValidate() update dependent fields.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DeliverySchedule	findDeliverySchedule(java.lang.String... args) Delivery Schedule.
InventoryAdjustmentItemType	findInventoryAdjustmentType(java.lang.String... args) Identifies the type of adjustment.
static ProductPartBreakDown	findKey(DataSource ds, int key) Find the target for this class by the primary key
InvoiceProductItem	findProductItem(java.lang.String... args) Product Item.
StockBinItem	findStockBinItem(java.lang.String... args) If product is inventoried then the Stock Item identifies the location that it is monitored.
java.util.Date	getDateTaken(java.lang.String... args)
DeliverySchedule	getDeliverySchedule(java.lang.String... args)
int	getID(java.lang.String... args)
InventoryAdjustmentItemType	getInventoryAdjustmentType(java.lang.String... args)
double	getInventoryAmountAdjusted(java.lang.String... args)
double	getInventoryCostOfSale(java.lang.String... args)
double	getInventoryQtyAdjusted(java.lang.String... args)
double	getInventoryQtyCommitted(java.lang.String... args)
ProductPartOrder	getPartOrder()
double	getPreviouslyTaken(java.lang.String... args)
InvoiceProductItem	getProductItem(java.lang.String... args)
double	getQtyTaken(java.lang.String... args)
StockBinItem	getStockBinItem(java.lang.String... args)
double	getTotalPrice(java.lang.String... args)
static DBQuery<ProductPartBreakDown>	makeQuery(DataSource ds) Make a new QUERY for this class.
ProductPartBreakDown	setDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule value, java.lang.String... args)
ProductPartBreakDown	setID(int value, java.lang.String... args)
ProductPartBreakDown	setInventoryCostOfSale(double value, java.lang.String... args)
ProductPartBreakDown	setPartOrder(com.aspc.dal.layers.aspc_app.invoice.ProductPartOrder value, java.lang.String... args)
ProductPartBreakDown	setProductItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value, java.lang.String... args)
ProductPartBreakDown	setQtyTaken(double value, java.lang.String... args)
ProductPartBreakDown	setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem 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, extCheckDeleteAccess, extCheckModifyAccess, extCopy, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

holds a record of when which product was taken for a part order

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

holds a record of when which product was taken for a part order

Constructor Detail

ProductPartBreakDown

public ProductPartBreakDown(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 ProductPartBreakDown setID(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDateTaken

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

getDeliverySchedule

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

findDeliverySchedule

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

Delivery Schedule.

--> DeliverySchedule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliverySchedule

Throws:

NotFoundException - DeliverySchedule was not found

setDeliverySchedule

@Nonnull
public ProductPartBreakDown setDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule 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)

getInventoryCostOfSale

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

setInventoryCostOfSale

@Nonnull
public ProductPartBreakDown setInventoryCostOfSale(double value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getInventoryQtyAdjusted

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

getInventoryQtyCommitted

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

setPartOrder

@Nonnull
public ProductPartBreakDown setPartOrder(com.aspc.dal.layers.aspc_app.invoice.ProductPartOrder value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getPreviouslyTaken

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

getProductItem

@CheckReturnValue
 @Nullable
public InvoiceProductItem getProductItem(java.lang.String... args)

findProductItem

@CheckReturnValue
 @Nonnull
public final InvoiceProductItem findProductItem(java.lang.String... args)
                                                                     throws NotFoundException

Product Item.

--> InvoiceProductItem (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceProductItem

Throws:

NotFoundException - InvoiceProductItem was not found

setProductItem

@Nonnull
public ProductPartBreakDown setProductItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getQtyTaken

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

setQtyTaken

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

Throws:

java.lang.Exception

getTotalPrice

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

create

@Nonnull
 @CheckReturnValue
public static ProductPartBreakDown 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<ProductPartBreakDown> 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 ProductPartBreakDown 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

getPartOrder

public ProductPartOrder getPartOrder()

Returns:

the value

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

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)

extDelete

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

Additional functionality when an object is marked for deletion by calling delete().

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extPreValidate

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

update dependent fields.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Additional access checking for READ access of this object.

Overrides:

extCheckReadAccess in class DBObject

Throws:

DBAccessException - No access to READ

See Also:

DBObject.checkReadAccess()

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()