com.aspc.Layers.aspc_app.ProductLabour

Class PriceMatrix

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.ProductLabour.PriceMatrix

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

PriceMatrix

public class PriceMatrix
extends DBObject

PriceMatrix defines the pricing based on a series of attributes The PriceMatrix provides standard sell prices for products depending on additional information such as quantity, customer, etc.

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

Since:

July 20, 2004, 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 The PriceMatrix provides standard sell prices for products depending on additional information such as quantity, customer, etc.
static java.lang.String	DBCLASS_NAME The PriceMatrix provides standard sell prices for products depending on additional information such as quantity, customer, etc.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PriceMatrix	create(MutableDataSource mds) Make a new instance of this class.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckDeleteAccess() Additional access checking for DELETE access for 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	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 void	extValidateRecord(ValidationList list) Performs additional validations on this record.
PriceMatrixRateCategory	findCategory(java.lang.String... args) Category.
Contact	findCustomer(java.lang.String... args) Customer.
static PriceMatrix	findKey(DataSource ds, int key) Find the target for this class by the primary key
Product	findProduct(java.lang.String... args) Product.
SalePromotionCode	findPromotionCode(java.lang.String... args) Code that represents the promotion on offer.
TaxCode	findSellTaxCodeId(java.lang.String... args) Tax code when sold.
PriceMatrixRateCategory	getCategory(java.lang.String... args)
Contact	getCustomer(java.lang.String... args)
java.lang.String	getDisplayShortDescription(java.lang.String... args)
int	getID(java.lang.String... args)
int	getMaxQty(java.lang.String... args)
int	getMinQty(java.lang.String... args)
Product	getProduct(java.lang.String... args)
SalePromotionCode	getPromotionCode(java.lang.String... args)
double	getRRP(java.lang.String... args)
TaxCode	getSellTaxCodeId(java.lang.String... args)
double	getTotalPrice(java.lang.String... args)
boolean	isPriceIncludesTax(java.lang.String... args)
boolean	isWithinQtyRange(java.lang.String... args)
static DBQuery<PriceMatrix>	makeQuery(DataSource ds) Make a new QUERY for this class.
PriceMatrix	setCategory(com.aspc.dal.layers.aspc_app.productlabour.PriceMatrixRateCategory value, java.lang.String... args)
PriceMatrix	setCustomer(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
PriceMatrix	setID(int value, java.lang.String... args)
PriceMatrix	setMaxQty(int value, java.lang.String... args)
PriceMatrix	setMinQty(int value, java.lang.String... args)
PriceMatrix	setPriceIncludesTax(boolean value, java.lang.String... args)
PriceMatrix	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
PriceMatrix	setPromotionCode(com.aspc.dal.layers.aspc_app.invoice.SalePromotionCode value, java.lang.String... args)
PriceMatrix	setRRP(double value, java.lang.String... args)
PriceMatrix	setSellTaxCodeId(com.aspc.dal.layers.aspc_app.misc.Tax value, java.lang.String... args)
PriceMatrix	setTotalPrice(double 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, eventFieldUpdated, extCanDeleteDependantObject, extCheckModifyAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

The PriceMatrix provides standard sell prices for products depending on additional information such as quantity, customer, etc.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The PriceMatrix provides standard sell prices for products depending on additional information such as quantity, customer, etc.

Constructor Detail

PriceMatrix

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

Throws:

java.lang.Exception

getRRP

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

setRRP

@Nonnull
public PriceMatrix setRRP(double value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getCategory

@CheckReturnValue
 @Nullable
public PriceMatrixRateCategory getCategory(java.lang.String... args)

findCategory

@CheckReturnValue
 @Nonnull
public final PriceMatrixRateCategory findCategory(java.lang.String... args)
                                                                       throws NotFoundException

Category.

--> .PriceMatrixRateCategory PriceMatrixRateCategory (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrixRateCategory

Throws:

NotFoundException - PriceMatrixRateCategory was not found

setCategory

@Nonnull
public PriceMatrix setCategory(com.aspc.dal.layers.aspc_app.productlabour.PriceMatrixRateCategory value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getCustomer

@CheckReturnValue
 @Nullable
public Contact getCustomer(java.lang.String... args)

findCustomer

@CheckReturnValue
 @Nonnull
public final Contact findCustomer(java.lang.String... args)
                                                       throws NotFoundException

Customer.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setCustomer

@Nonnull
public PriceMatrix setCustomer(com.aspc.dal.dbobj.contact.Contact value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayShortDescription

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

getMaxQty

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

setMaxQty

@Nonnull
public PriceMatrix setMaxQty(int value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getMinQty

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

setMinQty

@Nonnull
public PriceMatrix setMinQty(int value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isPriceIncludesTax

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

setPriceIncludesTax

@Nonnull
public PriceMatrix setPriceIncludesTax(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getProduct

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

findProduct

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

Product.

--> Product (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

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

Throws:

java.lang.Exception

getPromotionCode

@CheckReturnValue
 @Nullable
public SalePromotionCode getPromotionCode(java.lang.String... args)

findPromotionCode

@CheckReturnValue
 @Nonnull
public final SalePromotionCode findPromotionCode(java.lang.String... args)
                                                                      throws NotFoundException

Code that represents the promotion on offer.

--> SalePromotionCode (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SalePromotionCode

Throws:

NotFoundException - SalePromotionCode was not found

setPromotionCode

@Nonnull
public PriceMatrix setPromotionCode(com.aspc.dal.layers.aspc_app.invoice.SalePromotionCode value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSellTaxCodeId

@CheckReturnValue
 @Nullable
public TaxCode getSellTaxCodeId(java.lang.String... args)

findSellTaxCodeId

@CheckReturnValue
 @Nonnull
public final TaxCode findSellTaxCodeId(java.lang.String... args)
                                                            throws NotFoundException

Tax code when sold.

--> Tax (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Tax Codes

Throws:

NotFoundException - Tax was not found

setSellTaxCodeId

@Nonnull
public PriceMatrix setSellTaxCodeId(com.aspc.dal.layers.aspc_app.misc.Tax value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTotalPrice

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

setTotalPrice

@Nonnull
public PriceMatrix setTotalPrice(double value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isWithinQtyRange

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

create

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

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

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

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

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

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

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for DELETE access for this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete this object

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

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 DBObject

Throws:

java.lang.Exception - A serious problem