com.aspc.Layers.aspc_app.ProductLabour

Class Product

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.ProductLabour.ProductLabour

com.aspc.Layers.aspc_app.ProductLabour.Product

All Implemented Interfaces:

DependanceListener, SecondaryCacheGroup

Direct Known Subclasses:

Product, Product

public class Product
extends ProductLabour
implements DependanceListener

SDBJobItem is a Products and Materials used in Quotes, Jobs, Inventory and Purchases.

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

Since:

October 2, 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 and Materials used in Quotes, Jobs, Inventory and Purchases
static java.lang.String	DBCLASS_NAME Products and Materials used in Quotes, Jobs, Inventory and Purchases

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	doDependentsChanged()
void	eventDependantAdded(GlobalKey addedKey, GlobalKey sourceFieldKey) A record that points to this record was added.
void	eventDependantRemoved(GlobalKey removedKey, GlobalKey sourceFieldKey) A record that points to this record was removed.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected void	extFixUp() The extended fix up routine for known problems.
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 boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Product	findBaseProduct(java.lang.String... args) Other product which this product is based upon.
Product	findCalcDeliverySchedProduct(java.lang.String... args) Calculates the product that should be used for retrieving delivery schedule information.
Product	findCalcNoticeSchedProduct(java.lang.String... args) Calculates the product that should be used for retrieving notice schedule information.
Product	findCalcPriceMatrixProduct(java.lang.String... args) Calculates the product that should be used for retrieving price matrix information.
ProductCategory	findCategory(java.lang.String... args) The name for a group of products for example: computer software, computer hardware, network components.
StockBinItem	findDefaultStockBinItem(java.lang.String... args) Returns Stock Bin Item that represents this Product in the default Stock Bin.
SubscriptionTerm	findDefaultTerm(java.lang.String... args) Default Term.
ProductFulfillment	findFulfillment(java.lang.String... args) Identifies how the Product will be delivered.
Contact	findManufacturer(java.lang.String... args) The manufacturer of this item.
DBFile	findPicture(java.lang.String... args) A picture of the product may be added here.
Contact	findSupplier(java.lang.String... args) The main supplier of this product.
java.lang.String	getAlternativeDescription(java.lang.String... args)
java.lang.String	getBarCode(java.lang.String... args)
Product	getBaseProduct(java.lang.String... args)
Product	getBaseProductForItem(java.lang.String field)
double	getCalcActualRetailPrice(java.lang.String... args)
double	getCalcActualRetailPriceExTax(java.lang.String... args)
double	getCalcActualTax(java.lang.String... args)
Product	getCalcDeliverySchedProduct(java.lang.String... args)
Product	getCalcNoticeSchedProduct(java.lang.String... args)
Product	getCalcPriceMatrixProduct(java.lang.String... args)
int	getCalcSequence(java.lang.String... args)
ProductCategory	getCategory(java.lang.String... args)
int	getCirculationNum(java.lang.String... args)
java.util.Date	getDateAvailable(java.lang.String... args)
double	getDefaultPurchaseCost(java.lang.String... args)
StockBinItem	getDefaultStockBinItem(java.lang.String... args)
SubscriptionTerm	getDefaultTerm(java.lang.String... args)
java.lang.String	getDerivedDescriptionWithExtra(java.lang.String... args)
java.lang.String	getDerivedLongDescriptionHTML(java.lang.String... args)
java.lang.String	getDerivedShortDescription(java.lang.String... args)
java.lang.String	getDimensionUnit(java.lang.String... args)
long	getEAN(java.lang.String... args)
java.lang.String	getEvalPeriod(java.lang.String... args)
java.lang.String	getExtraDescription(java.lang.String... args)
java.util.List<java.lang.String>	getFalseBooleanFields(java.lang.String... args)
ProductFulfillment	getFulfillment(java.lang.String... args)
double	getGrossMarginMarkup(java.lang.String... args)
double	getHeight(java.lang.String... args)
long	getISBN(java.lang.String... args)
double	getItemsAvailable(java.lang.String... args)
double	getItemsOnBackOrder(java.lang.String... args)
double	getItemsSold(java.lang.String... args)
long	getJAN(java.lang.String... args)
java.lang.String	getKeywords(java.lang.String... args)
double	getLength(java.lang.String... args)
Contact	getManufacturer(java.lang.String... args)
double	getMargin(java.lang.String... args)
double	getMarkup(java.lang.String... args)
java.lang.String	getModel(java.lang.String... args)
java.lang.String	getMPN(java.lang.String... args)
DBFile	getPicture(java.lang.String... args)
java.util.Date	getRemoveDate(java.lang.String... args)
DBObject[]	getRoyalties()
double	getRRP(java.lang.String... args)
int	getSellToBuyUnitRatio(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getShortDescription(java.lang.String... args)
java.util.Date	getShowFromDate(java.lang.String... args)
double	getSpecialPriceIncludingTax(java.lang.String... args)
java.util.Date	getSpEndDate(java.lang.String... args)
java.util.Date	getSpStartDate(java.lang.String... args)
Contact	getSupplier(java.lang.String... args)
java.lang.String	getSupplierLongDescriptionHTML(java.lang.String... args)
java.lang.String	getSupplierProductCode(java.lang.String... args)
java.lang.String	getSupplierShortDescription(java.lang.String... args)
double	getTotalCost(java.lang.String... args)
double	getTotalCostIncTax(java.lang.String... args)
double	getTotalOptionalCost(java.lang.String... args)
double	getTotalOptionalCostIncTax(java.lang.String... args)
double	getTotalPurchasedItems(java.lang.String... args)
java.lang.String	getType(java.lang.String... args)
long	getUPC(java.lang.String... args)
double	getWeight(java.lang.String... args)
java.lang.String	getWeightUnit(java.lang.String... args) Deprecated.
double	getWidth(java.lang.String... args)
boolean	hasChildProducts(java.lang.String... args)
boolean	hasDeliverySchedule(FldParams params)
boolean	hasStock(java.lang.String... args)
boolean	hasVariant(java.lang.String... args)
boolean	isFeaturedProduct(java.lang.String... args)
boolean	isIBuyThis(java.lang.String... args)
boolean	isIInventoryThis(java.lang.String... args)
boolean	isISellThis(java.lang.String... args)
boolean	isLockMarkup(java.lang.String... args)
boolean	isRequiresShipping(java.lang.String... args)
boolean	isShowRRP(java.lang.String... args)
NoticeSchedule[]	listNoticeSchedules() Returns a list of notice schedules linked to this product
DBObject[]	listVariant() get all product variants of this product
Product	setAlternativeDescription(java.lang.String value, java.lang.String... args)
Product	setBarCode(java.lang.String value, java.lang.String... args)
Product	setBaseProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
Product	setCategory(com.aspc.dal.layers.aspc_app.productlabour.ProductCategory value, java.lang.String... args)
Product	setCirculationNum(int value, java.lang.String... args)
Product	setDateAvailable(java.util.Date value, java.lang.String... args)
Product	setDefaultPurchaseCost(double value, java.lang.String... args)
Product	setDefaultTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value, java.lang.String... args)
Product	setDimensionUnit(java.lang.String value, java.lang.String... args)
Product	setEAN(long value, java.lang.String... args)
Product	setEvalPeriod(java.lang.String value, java.lang.String... args)
Product	setExtraDescription(java.lang.String value, java.lang.String... args)
Product	setFalseBooleanFields(java.util.List<java.lang.String> value, java.lang.String... args)
Product	setFeaturedProduct(boolean value, java.lang.String... args)
Product	setFulfillment(com.aspc.dal.layers.aspc_app.productlabour.ProductFulfillment value, java.lang.String... args)
Product	setHeight(double value, java.lang.String... args)
Product	setIBuyThis(boolean value, java.lang.String... args)
Product	setIInventoryThis(boolean value, java.lang.String... args)
Product	setISBN(long value, java.lang.String... args)
Product	setISellThis(boolean value, java.lang.String... args)
Product	setJAN(long value, java.lang.String... args)
Product	setKeywords(java.lang.String value, java.lang.String... args)
Product	setLength(double value, java.lang.String... args)
Product	setLockMarkup(boolean value, java.lang.String... args)
Product	setManufacturer(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Product	setMarkup(double value, java.lang.String... args)
Product	setModel(java.lang.String value, java.lang.String... args)
Product	setMPN(java.lang.String value, java.lang.String... args)
Product	setPicture(com.aspc.dal.file.DBFile value, java.lang.String... args)
Product	setRemoveDate(java.util.Date value, java.lang.String... args)
Product	setRequiresShipping(boolean value, java.lang.String... args)
Product	setRRP(double value, java.lang.String... args)
Product	setSellToBuyUnitRatio(int value, java.lang.String... args)
Product	setSequence(int value, java.lang.String... args)
Product	setShortDescription(java.lang.String value, java.lang.String... args)
Product	setShowFromDate(java.util.Date value, java.lang.String... args)
Product	setShowRRP(boolean value, java.lang.String... args)
Product	setSpecialPriceIncludingTax(double value, java.lang.String... args)
Product	setSpEndDate(java.util.Date value, java.lang.String... args)
Product	setSpStartDate(java.util.Date value, java.lang.String... args)
Product	setSupplier(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Product	setSupplierLongDescriptionHTML(java.lang.String value, java.lang.String... args)
Product	setSupplierProductCode(java.lang.String value, java.lang.String... args)
Product	setSupplierShortDescription(java.lang.String value, java.lang.String... args)
Product	setTotalPurchasedItems(double value, java.lang.String... args)
Product	setType(java.lang.String value, java.lang.String... args)
Product	setUPC(long value, java.lang.String... args)
Product	setUseBaseDeliverySched(boolean value, java.lang.String... args)
Product	setUseBaseIssueAlloc(boolean value, java.lang.String... args)
Product	setUseBaseNoticeSched(boolean value, java.lang.String... args)
Product	setUseBasePriceMatrix(boolean value, java.lang.String... args)
Product	setWeight(double value, java.lang.String... args)
Product	setWeightUnit(java.lang.String value, java.lang.String... args) Deprecated.
Product	setWidth(double value, java.lang.String... args)
void	updateProductCategoryMap()
void	updateProductImage()
void	updateStockBinItem(DataSource dataSource)
boolean	useBaseDeliverySched(java.lang.String... args)
boolean	useBaseIssueAlloc(java.lang.String... args)
boolean	useBaseNoticeSched(java.lang.String... args)
boolean	useBasePriceMatrix(java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.ProductLabour.ProductLabour

create, findBuyTaxCodeId, findEnteredBy, findExpenseAccount, findIncomeAccount, findKey, findOwnerBusUnit, findSellTaxCodeId, getBuyingUnitMeasure, getBuyPrice, getBuyTaxCodeId, getCalcBuyPriceExcludingTax, getCalcBuyPriceIncludingTax, getCalcSellPriceIncludingTax, getDescription, getEnteredBy, getExpenseAccount, getIDNo, getIncomeAccount, getLabourHours, getNotes, getObsoleteNotes, getOwnerBusUnit, getSellPrice, getSellTaxCodeId, getSellUnitMeasure, isBuyPriceIncludesTax, isHtmlTextNote, isInactive, isSellPriceIncludesTax, makeQuery, setBuyingUnitMeasure, setBuyPrice, setBuyPriceIncludesTax, setBuyTaxCodeId, setDescription, setEnteredBy, setExpenseAccount, setHtmlTextNote, setIDNo, setInactive, setIncomeAccount, setLabourHours, setNotes, setObsoleteNotes, setOwnerBusUnit, setSellPrice, setSellPriceIncludesTax, setSellTaxCodeId, setSellUnitMeasure

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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

Products and Materials used in Quotes, Jobs, Inventory and Purchases

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Products and Materials used in Quotes, Jobs, Inventory and Purchases

Constructor Detail

Product

public Product(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

getEAN

@CheckReturnValue
public long getEAN(java.lang.String... args)

setEAN

@Nonnull
public Product setEAN(long value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getISBN

@CheckReturnValue
public long getISBN(java.lang.String... args)

setISBN

@Nonnull
public Product setISBN(long value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getJAN

@CheckReturnValue
public long getJAN(java.lang.String... args)

setJAN

@Nonnull
public Product setJAN(long value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getMPN

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

setMPN

@Nonnull
public Product setMPN(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getMargin

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

getMarkup

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

setMarkup

@Nonnull
public Product setMarkup(double 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 Product setRRP(double value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getUPC

@CheckReturnValue
public long getUPC(java.lang.String... args)

setUPC

@Nonnull
public Product setUPC(long value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getAlternativeDescription

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

setAlternativeDescription

@Nonnull
public Product setAlternativeDescription(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getBarCode

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

setBarCode

@Nonnull
public Product setBarCode(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getBaseProduct

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

findBaseProduct

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

Other product which this product is based upon.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setBaseProduct

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

Throws:

java.lang.Exception

getCalcActualRetailPrice

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

getCalcActualRetailPriceExTax

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

getCalcActualTax

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

getCalcDeliverySchedProduct

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

findCalcDeliverySchedProduct

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

Calculates the product that should be used for retrieving delivery schedule information.

--> Product (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

getCalcNoticeSchedProduct

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

findCalcNoticeSchedProduct

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

Calculates the product that should be used for retrieving notice schedule information.

--> Product (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

getCalcPriceMatrixProduct

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

findCalcPriceMatrixProduct

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

Calculates the product that should be used for retrieving price matrix information.

--> Product (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

getCalcSequence

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

getCategory

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

findCategory

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

The name for a group of products for example: computer software, computer hardware, network components.

--> ProductCategory (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductCategory

Throws:

NotFoundException - ProductCategory was not found

setCategory

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

Throws:

java.lang.Exception

getCirculationNum

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

setCirculationNum

@Nonnull
public Product setCirculationNum(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDateAvailable

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

setDateAvailable

@Nonnull
public Product setDateAvailable(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultPurchaseCost

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

setDefaultPurchaseCost

@Nonnull
public Product setDefaultPurchaseCost(double value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultStockBinItem

@CheckReturnValue
 @Nullable
public StockBinItem getDefaultStockBinItem(java.lang.String... args)

findDefaultStockBinItem

@CheckReturnValue
 @Nonnull
public final StockBinItem findDefaultStockBinItem(java.lang.String... args)
                                                                       throws NotFoundException

Returns Stock Bin Item that represents this Product in the default Stock Bin.

--> StockBinItem (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

StockBinItem

Throws:

NotFoundException - StockBinItem was not found

getDefaultTerm

@CheckReturnValue
 @Nullable
public SubscriptionTerm getDefaultTerm(java.lang.String... args)

findDefaultTerm

@CheckReturnValue
 @Nonnull
public final SubscriptionTerm findDefaultTerm(java.lang.String... args)
                                                                   throws NotFoundException

Default Term.

--> SubscriptionTerm (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SubscriptionTerm

Throws:

NotFoundException - SubscriptionTerm was not found

setDefaultTerm

@Nonnull
public Product setDefaultTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDerivedDescriptionWithExtra

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

getDerivedLongDescriptionHTML

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

getDerivedShortDescription

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

getDimensionUnit

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

setDimensionUnit

@Nonnull
public Product setDimensionUnit(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getEvalPeriod

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

setEvalPeriod

@Nonnull
public Product setEvalPeriod(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getExtraDescription

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

setExtraDescription

@Nonnull
public Product setExtraDescription(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getFalseBooleanFields

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getFalseBooleanFields(java.lang.String... args)

setFalseBooleanFields

@Nonnull
public Product setFalseBooleanFields(java.util.List<java.lang.String> value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getFulfillment

@CheckReturnValue
 @Nullable
public ProductFulfillment getFulfillment(java.lang.String... args)

findFulfillment

@CheckReturnValue
 @Nonnull
public final ProductFulfillment findFulfillment(java.lang.String... args)
                                                                     throws NotFoundException

Identifies how the Product will be delivered.

--> .ProductFulfillment ProductFulfillment (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductFulfillment

Throws:

NotFoundException - ProductFulfillment was not found

setFulfillment

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

Throws:

java.lang.Exception

getGrossMarginMarkup

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

hasChildProducts

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

hasStock

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

hasVariant

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

getHeight

@CheckReturnValue
 @Nonnegative
public double getHeight(java.lang.String... args)

setHeight

@Nonnull
public Product setHeight(double value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

isIBuyThis

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

setIBuyThis

@Nonnull
public Product setIBuyThis(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isIInventoryThis

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

setIInventoryThis

@Nonnull
public Product setIInventoryThis(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isISellThis

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

setISellThis

@Nonnull
public Product setISellThis(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isFeaturedProduct

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

setFeaturedProduct

@Nonnull
public Product setFeaturedProduct(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getItemsAvailable

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

getItemsOnBackOrder

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

getItemsSold

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

getKeywords

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

setKeywords

@Nonnull
public Product setKeywords(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getLength

@CheckReturnValue
 @Nonnegative
public double getLength(java.lang.String... args)

setLength

@Nonnull
public Product setLength(double value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

isLockMarkup

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

setLockMarkup

@Nonnull
public Product setLockMarkup(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getManufacturer

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

findManufacturer

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

The manufacturer of this item.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setManufacturer

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

Throws:

java.lang.Exception

getModel

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

setModel

@Nonnull
public Product setModel(java.lang.String 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 may be added here.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setPicture

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

Throws:

java.lang.Exception

getRemoveDate

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

setRemoveDate

@Nonnull
public Product setRemoveDate(java.util.Date value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isRequiresShipping

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

setRequiresShipping

@Nonnull
public Product setRequiresShipping(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getSellToBuyUnitRatio

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

setSellToBuyUnitRatio

@Nonnull
public Product setSellToBuyUnitRatio(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

setSequence

@Nonnull
public Product setSequence(int value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getShortDescription

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

setShortDescription

@Nonnull
public Product setShortDescription(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getShowFromDate

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

setShowFromDate

@Nonnull
public Product setShowFromDate(java.util.Date value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isShowRRP

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

setShowRRP

@Nonnull
public Product setShowRRP(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getSpEndDate

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

setSpEndDate

@Nonnull
public Product setSpEndDate(java.util.Date value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getSpStartDate

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

setSpStartDate

@Nonnull
public Product setSpStartDate(java.util.Date value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSpecialPriceIncludingTax

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

setSpecialPriceIncludingTax

@Nonnull
public Product setSpecialPriceIncludingTax(double value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getSupplier

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

findSupplier

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

The main supplier of this product.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setSupplier

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

Throws:

java.lang.Exception

getSupplierLongDescriptionHTML

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

setSupplierLongDescriptionHTML

@Nonnull
public Product setSupplierLongDescriptionHTML(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getSupplierProductCode

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

setSupplierProductCode

@Nonnull
public Product setSupplierProductCode(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSupplierShortDescription

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

setSupplierShortDescription

@Nonnull
public Product setSupplierShortDescription(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTotalCost

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

getTotalCostIncTax

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

getTotalOptionalCost

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

getTotalOptionalCostIncTax

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

getTotalPurchasedItems

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

setTotalPurchasedItems

@Nonnull
public Product setTotalPurchasedItems(double value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getType

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

setType

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

Throws:

java.lang.Exception

useBaseDeliverySched

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

setUseBaseDeliverySched

@Nonnull
public Product setUseBaseDeliverySched(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

useBaseIssueAlloc

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

setUseBaseIssueAlloc

@Nonnull
public Product setUseBaseIssueAlloc(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

useBaseNoticeSched

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

setUseBaseNoticeSched

@Nonnull
public Product setUseBaseNoticeSched(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

useBasePriceMatrix

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

setUseBasePriceMatrix

@Nonnull
public Product setUseBasePriceMatrix(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getWeight

@CheckReturnValue
 @Nonnegative
public double getWeight(java.lang.String... args)

setWeight

@Nonnull
public Product setWeight(double value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getWeightUnit

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getWeightUnit(java.lang.String... args)

Deprecated.

setWeightUnit

@Deprecated
 @Nonnull
public Product setWeightUnit(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getWidth

@CheckReturnValue
 @Nonnegative
public double getWidth(java.lang.String... args)

setWidth

@Nonnull
public Product setWidth(double value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getRoyalties

public DBObject[] getRoyalties()

Returns:

the value

getBaseProductForItem

public Product getBaseProductForItem(java.lang.String field)

Parameters:

field - The field

Returns:

the value

hasDeliverySchedule

public boolean hasDeliverySchedule(FldParams params)

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

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

listVariant

public DBObject[] listVariant()
                       throws java.lang.Exception

get all product variants of this product

Returns:

product variants in sequence order

Throws:

java.lang.Exception

extGetDerivedGlobalKey

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

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)

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 DBObject

Parameters:

field - The field

Returns:

the value

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A serious problem

extAutoEnterCreate

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

Description copied from class: DBObject

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate in class DBObject

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

updateProductImage

public void updateProductImage()
                        throws java.lang.Exception

Throws:

java.lang.Exception

updateProductCategoryMap

public void updateProductCategoryMap()
                              throws java.lang.Exception

Throws:

java.lang.Exception - Exception A serious problem

updateStockBinItem

public void updateStockBinItem(DataSource dataSource)
                        throws java.lang.Exception

Parameters:

dataSource - the data source

Throws:

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

Throws:

java.lang.Exception - A serious problem

eventDependantAdded

public void eventDependantAdded(GlobalKey addedKey,
                                GlobalKey sourceFieldKey)

A record that points to this record was added. The object is available via findKey.

Specified by:

eventDependantAdded in interface DependanceListener

Parameters:

addedKey - The record's key that was added.

sourceFieldKey - Via which field is this object linked ?

See Also:

DependanceListener.eventDependantAdded( GlobalKey addedKey, GlobalKey sourceFieldKey)

eventDependantRemoved

public void eventDependantRemoved(GlobalKey removedKey,
                                  GlobalKey sourceFieldKey)

A record that points to this record was removed. Only the global key is available now.

Specified by:

eventDependantRemoved in interface DependanceListener

Parameters:

removedKey - The record key that was removed.

sourceFieldKey - Via which field is this object linked ?

See Also:

DependanceListener.eventDependantRemoved( GlobalKey removedKey, GlobalKey sourceFieldKey)

doDependentsChanged

protected void doDependentsChanged()

listNoticeSchedules

public NoticeSchedule[] listNoticeSchedules()

Returns a list of notice schedules linked to this product

Returns:

the value