com.aspc.cms.cart

Class ShippingRuleVariant

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.cart.ShippingRuleVariant

All Implemented Interfaces:

SecondaryCacheGroup

public class ShippingRuleVariant
extends DBObject

Shipping Rule Variants.

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

Since:

01 July 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 Shipping Rule Variants
static java.lang.String	DBCLASS_NAME Shipping Rule Variants

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
ShippingRuleVariant(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static boolean	canShip(DataSource datasource, double weight, double length, double width, double height)
static ShippingRuleVariant	create(MutableDataSource mds) Make a new instance of this class.
static ShippingRuleVariant	findKey(DataSource ds, int key) Find the target for this class by the primary key
ShippingRule	findRule(java.lang.String... args) Shipping Rule.
int	getID(java.lang.String... args)
double	getMaxWeight(java.lang.String... args)
double	getMinProductPrice(java.lang.String... args)
double	getPrice(java.lang.String... args)
ShippingRule	getRule(java.lang.String... args)
static java.util.HashMap<ShippingRule,PackingMethod>	getShippingCost(DataSource ds, java.util.ArrayList<ShippingProductInfo> list, double price, java.lang.String suburb, java.lang.String state, java.lang.String country)
static java.util.HashMap<ShippingRule,PackingMethod>	getShippingCost(DataSource ds, java.util.ArrayList<ShippingProductInfo> list, double price, java.lang.String suburb, java.lang.String state, java.lang.String country, Region region) find all matching shipping rules
static java.util.HashMap<ShippingRule,PackingMethod>	getShippingCost(DataSource ds, java.util.ArrayList<ShippingProductInfo> list, java.lang.String suburb, java.lang.String state, java.lang.String country)
static java.util.HashMap<ShippingRule,PackingMethod>	getShippingCost(DataSource ds, java.util.ArrayList<ShippingProductInfo> list, java.lang.String suburb, java.lang.String state, java.lang.String country, Region region)
static java.util.ArrayList<Package>	getVariants(ShippingProductInfo[] infos, ShippingRuleVariant[] variants) This method should NOT be used by any class other than ShippingRuleVariant, The reason that I don't set this method to private is there is one test case testing this method this method tries to find a cheapest way to pack all items steps: 1.
static java.util.ArrayList<Package>	getVariantsV2(ShippingProductInfo[] infos, ShippingRuleVariant[] variants)
double	getX(java.lang.String... args)
double	getY(java.lang.String... args)
double	getZ(java.lang.String... args)
boolean	isInactive(java.lang.String... args)
static DBQuery<ShippingRuleVariant>	makeQuery(DataSource ds) Make a new QUERY for this class.
ShippingRuleVariant	setID(int value, java.lang.String... args)
ShippingRuleVariant	setInactive(boolean value, java.lang.String... args)
ShippingRuleVariant	setMaxWeight(double value, java.lang.String... args)
ShippingRuleVariant	setMinProductPrice(double value, java.lang.String... args)
ShippingRuleVariant	setPrice(double value, java.lang.String... args)
ShippingRuleVariant	setRule(com.aspc.dal.cms.cart.ShippingRule value, java.lang.String... args)
ShippingRuleVariant	setX(double value, java.lang.String... args)
ShippingRuleVariant	setY(double value, java.lang.String... args)
ShippingRuleVariant	setZ(double value, java.lang.String... args)
java.lang.String	toString() The description.

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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, 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

Shipping Rule Variants

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Shipping Rule Variants

Constructor Detail

ShippingRuleVariant

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

Throws:

java.lang.Exception

isInactive

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

setInactive

@Nonnull
public ShippingRuleVariant setInactive(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getMaxWeight

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

setMaxWeight

@Nonnull
public ShippingRuleVariant setMaxWeight(double value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getMinProductPrice

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

setMinProductPrice

@Nonnull
public ShippingRuleVariant setMinProductPrice(double value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getPrice

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

setPrice

@Nonnull
public ShippingRuleVariant setPrice(double value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRule

@CheckReturnValue
 @Nullable
public ShippingRule getRule(java.lang.String... args)

findRule

@CheckReturnValue
 @Nonnull
public final ShippingRule findRule(java.lang.String... args)
                                                        throws NotFoundException

Shipping Rule.

--> ShippingRule (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ShippingRule

Throws:

NotFoundException - ShippingRule was not found

setRule

@Nonnull
public ShippingRuleVariant setRule(com.aspc.dal.cms.cart.ShippingRule value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getX

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

setX

@Nonnull
public ShippingRuleVariant setX(double value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getY

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

setY

@Nonnull
public ShippingRuleVariant setY(double value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getZ

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

setZ

@Nonnull
public ShippingRuleVariant setZ(double value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

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

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

canShip

public static boolean canShip(DataSource datasource,
                              double weight,
                              double length,
                              double width,
                              double height)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getShippingCost

public static java.util.HashMap<ShippingRule,PackingMethod> getShippingCost(DataSource ds,
                                                                            java.util.ArrayList<ShippingProductInfo> list,
                                                                            java.lang.String suburb,
                                                                            java.lang.String state,
                                                                            java.lang.String country)
                                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getShippingCost

public static java.util.HashMap<ShippingRule,PackingMethod> getShippingCost(DataSource ds,
                                                                            java.util.ArrayList<ShippingProductInfo> list,
                                                                            double price,
                                                                            java.lang.String suburb,
                                                                            java.lang.String state,
                                                                            java.lang.String country)
                                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getShippingCost

public static java.util.HashMap<ShippingRule,PackingMethod> getShippingCost(DataSource ds,
                                                                            java.util.ArrayList<ShippingProductInfo> list,
                                                                            java.lang.String suburb,
                                                                            java.lang.String state,
                                                                            java.lang.String country,
                                                                            Region region)
                                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getShippingCost

public static java.util.HashMap<ShippingRule,PackingMethod> getShippingCost(DataSource ds,
                                                                            java.util.ArrayList<ShippingProductInfo> list,
                                                                            double price,
                                                                            java.lang.String suburb,
                                                                            java.lang.String state,
                                                                            java.lang.String country,
                                                                            Region region)
                                                                     throws java.lang.Exception

find all matching shipping rules

Parameters:

ds -

list -

price -

suburb -

state -

country -

region -

Returns:

Throws:

java.lang.Exception

getVariants

public static java.util.ArrayList<Package> getVariants(ShippingProductInfo[] infos,
                                                       ShippingRuleVariant[] variants)

This method should NOT be used by any class other than ShippingRuleVariant, The reason that I don't set this method to private is there is one test case testing this method this method tries to find a cheapest way to pack all items steps: 1. try to put the first item in the first variant 2. try to put the smaller items in the first package 3. repeat steps 1 and 2 4. try to put all items in this package into a smallest variant to save shipping cost

Parameters:

infos - all product items, sorted by weight desc, any item must fit at least one variant

variants - all variants, sorted by price, we think higher price always has the higher weight capability

Returns:

the value

getVariantsV2

public static java.util.ArrayList<Package> getVariantsV2(ShippingProductInfo[] infos,
                                                         ShippingRuleVariant[] variants)