com.aspc.cms.cart

Class ShoppingCartItemOption

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.cart.ShoppingCartItemOption

All Implemented Interfaces:

SecondaryCacheGroup

public class ShoppingCartItemOption
extends DBObject

The options of a shopping cart item.

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

Since:

26 May 2014

Author:

Lei Gao

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 options of a shopping cart item
static java.lang.String	DBCLASS_NAME The options of a shopping cart item

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
ShoppingCartItemOption(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
boolean	canRead(java.lang.String... args)
static ShoppingCartItemOption	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 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	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
ShoppingCartItem	findItem(java.lang.String... args) Shopping Cart Item.
static ShoppingCartItemOption	findKey(DataSource ds, int key) Find the target for this class by the primary key
ProductOption	findOption(java.lang.String... args) Option of the item.
ShoppingCart	findShoppingCart(java.lang.String... args) Shopping Cart.
double	getCalcItemHeight(java.lang.String... args)
double	getCalcItemLength(java.lang.String... args)
double	getCalcItemTotalPrice(java.lang.String... args)
double	getCalcItemTotalPriceExTax(java.lang.String... args)
double	getCalcItemTotalTax(java.lang.String... args)
double	getCalcItemTotalWeight(java.lang.String... args)
double	getCalcItemUnitPrice(java.lang.String... args)
double	getCalcItemUnitPriceExTax(java.lang.String... args)
double	getCalcItemUnitTax(java.lang.String... args)
double	getCalcItemUnitWeight(java.lang.String... args)
double	getCalcItemWidth(java.lang.String... args)
java.lang.String	getDerivedProductDisplayName(java.lang.String... args)
int	getID(java.lang.String... args)
ShoppingCartItem	getItem(java.lang.String... args)
ProductOption	getOption(java.lang.String... args)
java.lang.String	getOptionName(java.lang.String... args)
int	getQty(java.lang.String... args)
ShoppingCart	getShoppingCart(java.lang.String... args)
static DBQuery<ShoppingCartItemOption>	makeQuery(DataSource ds) Make a new QUERY for this class.
ShoppingCartItemOption	setID(int value, java.lang.String... args)
ShoppingCartItemOption	setItem(com.aspc.dal.cms.cart.ShoppingCartItem value, java.lang.String... args)
ShoppingCartItemOption	setOption(com.aspc.dal.layers.aspc_app.productlabour.ProductOption value, java.lang.String... args)
ShoppingCartItemOption	setOptionName(java.lang.String value, java.lang.String... args)
ShoppingCartItemOption	setQty(int 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, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

The options of a shopping cart item

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The options of a shopping cart item

Constructor Detail

ShoppingCartItemOption

public ShoppingCartItemOption(DBClass theClass,
                              DataSource dataSource)
                       throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getID

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

setID

@Nonnull
public ShoppingCartItemOption setID(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getCalcItemHeight

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

getCalcItemLength

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

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)

getCalcItemUnitPrice

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

getCalcItemUnitPriceExTax

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

getCalcItemUnitTax

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

getCalcItemUnitWeight

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

getCalcItemWidth

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

canRead

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

getDerivedProductDisplayName

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

getItem

@CheckReturnValue
 @Nullable
public ShoppingCartItem getItem(java.lang.String... args)

findItem

@CheckReturnValue
 @Nonnull
public final ShoppingCartItem findItem(java.lang.String... args)
                                                            throws NotFoundException

Shopping Cart Item.

--> ShoppingCartItem (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ShoppingCartItem

Throws:

NotFoundException - ShoppingCartItem was not found

setItem

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

Throws:

java.lang.Exception

getOption

@CheckReturnValue
 @Nullable
public ProductOption getOption(java.lang.String... args)

findOption

@CheckReturnValue
 @Nonnull
public final ProductOption findOption(java.lang.String... args)
                                                           throws NotFoundException

Option of the item.

--> ProductOption (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductOption

Throws:

NotFoundException - ProductOption was not found

setOption

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

Throws:

java.lang.Exception

getOptionName

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

setOptionName

@Nonnull
public ShoppingCartItemOption setOptionName(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getQty

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

setQty

@Nonnull
public ShoppingCartItemOption setQty(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

Shopping Cart.

--> ShoppingCart (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ShoppingCart

Throws:

NotFoundException - ShoppingCart was not found

create

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

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

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

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