com.aspc.cms.cart

Class ShoppingCartItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.cart.ShoppingCartItem

All Implemented Interfaces:

SecondaryCacheGroup

public class ShoppingCartItem
extends DBObject

DBOrder is a sale order The shopping Cart Item.

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

Since:

06 June 2013

Author:

Liam Itzhaki

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 shopping Cart Item
static java.lang.String	DBCLASS_NAME The shopping Cart Item

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canRead(java.lang.String... args)
static ShoppingCartItem	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
protected void	extFixUp() The extended fix up routine
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static ShoppingCartItem	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
Product	findProduct(java.lang.String... args) Linked to Product.
ShoppingCart	findShoppingCart(java.lang.String... args) The shopping cart.
double	getCalcItemTotalPrice(java.lang.String... args)
double	getCalcItemTotalPriceExTax(java.lang.String... args)
double	getCalcItemTotalTax(java.lang.String... args)
double	getCalcItemTotalWeight(java.lang.String... args)
int	getCalcQuantityWithNoOption(java.lang.String... args)
java.util.ArrayList<ShoppingCartItemOption>	getCartItemOptions()
java.lang.String	getCode(java.lang.String... args)
double	getDerivedProductActualRetailPrice(java.lang.String... args)
double	getDerivedProductActualRPExTax(java.lang.String... args)
double	getDerivedProductActualTax(java.lang.String... args)
double	getDerivedProductBuyTaxRate(java.lang.String... args)
java.lang.String	getDerivedProductDescription(java.lang.String... args)
java.lang.String	getDerivedProductGK(java.lang.String... args)
double	getDerivedProductHeight(java.lang.String... args)
double	getDerivedProductLength(java.lang.String... args)
java.lang.String	getDerivedProductPrimaryPicturePath(java.lang.String... args)
java.lang.String	getDerivedProductShortDescription(java.lang.String... args)
double	getDerivedProductWeight(java.lang.String... args)
double	getDerivedProductWidth(java.lang.String... args)
Product	getProduct(java.lang.String... args)
java.lang.String	getProductKey(java.lang.String... args)
protected java.lang.String	getProductValueForPublic(java.lang.String fieldname, java.lang.String subFieldname)
int	getQuantity(java.lang.String... args)
ShoppingCart	getShoppingCart(java.lang.String... args)
static DBQuery<ShoppingCartItem>	makeQuery(DataSource ds) Make a new QUERY for this class.
ShoppingCartItem	setCode(java.lang.String value, java.lang.String... args)
ShoppingCartItem	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
ShoppingCartItem	setProductKey(java.lang.String value, java.lang.String... args)
ShoppingCartItem	setQuantity(int value, java.lang.String... args)
ShoppingCartItem	setShoppingCart(com.aspc.dal.cms.cart.ShoppingCart 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, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, 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 shopping Cart Item

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The shopping Cart Item

Constructor Detail

ShoppingCartItem

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

getCode

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

setCode

@Nonnull
public ShoppingCartItem setCode(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCalcItemTotalPrice

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

getCalcItemTotalPriceExTax

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

getCalcItemTotalTax

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

getCalcItemTotalWeight

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

getCalcQuantityWithNoOption

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

canRead

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

getDerivedProductActualRPExTax

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

getDerivedProductActualRetailPrice

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

getDerivedProductActualTax

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

getDerivedProductBuyTaxRate

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

getDerivedProductDescription

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

getDerivedProductGK

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

getDerivedProductHeight

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

getDerivedProductLength

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

getDerivedProductPrimaryPicturePath

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

getDerivedProductShortDescription

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

getDerivedProductWeight

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

getDerivedProductWidth

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

getProduct

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

findProduct

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

Linked to Product.

--> Product (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

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

Throws:

java.lang.Exception

getProductKey

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

setProductKey

@Nonnull
public ShoppingCartItem setProductKey(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getQuantity

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

setQuantity

@Nonnull
public ShoppingCartItem setQuantity(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getShoppingCart

@CheckReturnValue
 @Nullable
public ShoppingCart getShoppingCart(java.lang.String... args)

findShoppingCart

@CheckReturnValue
 @Nonnull
public final ShoppingCart findShoppingCart(java.lang.String... args)
                                                                throws NotFoundException

The shopping cart.

--> ShoppingCart (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ShoppingCart

Throws:

NotFoundException - ShoppingCart was not found

setShoppingCart

@Nonnull
public ShoppingCartItem setShoppingCart(com.aspc.dal.cms.cart.ShoppingCart value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static ShoppingCartItem 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<ShoppingCartItem> 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 ShoppingCartItem findKey(@Nonnull
                                                                   DataSource ds,
                                                                   @Nonnull
                                                                   java.lang.String 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

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

getCartItemOptions

public java.util.ArrayList<ShoppingCartItemOption> getCartItemOptions()
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

getProductValueForPublic

protected java.lang.String getProductValueForPublic(java.lang.String fieldname,
                                                    java.lang.String subFieldname)

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to be notified when a field changes. This method should not trigger a save of this record because you may save a record in a half updated state.
TODO: Put in a programmer check for a save during this method call.

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

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

Returns:

true if the field affects others when changed

extValidateRecord

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

Description copied from class: DBObject

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extFixUp

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

Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem