com.aspc.cms.cart

Class ShippingRule

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.cart.ShippingRule

All Implemented Interfaces:

SecondaryCacheGroup

public class ShippingRule
extends DBObject

Shipping Rules.

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 Rules
static java.lang.String	DBCLASS_NAME Shipping Rules

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
ShippingRule(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static ShippingRule	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
Country	findCountry(java.lang.String... args) Country of this rule.
static ShippingRule	findKey(DataSource ds, int key) Find the target for this class by the primary key
Region	findRegion(java.lang.String... args) Region of this rule Paypal country code: https://developer.paypal.com/docs/classic/api /country_codes/ --> Region (String, Searchable)
LogisticsService	findService(java.lang.String... args) Logistics Service.
StateRegion	findState(java.lang.String... args) State of the rule.
Suburb	findSuburb(java.lang.String... args) Suburb of the rule.
int	getAdjPriority(java.lang.String... args)
Country	getCountry(java.lang.String... args)
java.lang.String	getDeliveryTime(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
int	getPriority(java.lang.String... args)
Region	getRegion(java.lang.String... args)
LogisticsService	getService(java.lang.String... args)
StateRegion	getState(java.lang.String... args)
Suburb	getSuburb(java.lang.String... args)
boolean	isInactive(java.lang.String... args)
static DBQuery<ShippingRule>	makeQuery(DataSource ds) Make a new QUERY for this class.
ShippingRule	setAdjPriority(int value, java.lang.String... args)
ShippingRule	setCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
ShippingRule	setDeliveryTime(java.lang.String value, java.lang.String... args)
ShippingRule	setID(int value, java.lang.String... args)
ShippingRule	setInactive(boolean value, java.lang.String... args)
ShippingRule	setName(java.lang.String value, java.lang.String... args)
ShippingRule	setRegion(com.aspc.dal.layers.aspc_app.misc.Region value, java.lang.String... args)
ShippingRule	setService(com.aspc.dal.cms.cart.LogisticsService value, java.lang.String... args)
ShippingRule	setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)
ShippingRule	setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb 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, 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 Rules

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Shipping Rules

Constructor Detail

ShippingRule

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

Throws:

java.lang.Exception

getAdjPriority

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

setAdjPriority

@Nonnull
public ShippingRule setAdjPriority(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getCountry

@CheckReturnValue
 @Nullable
public Country getCountry(java.lang.String... args)

findCountry

@CheckReturnValue
 @Nonnull
public final Country findCountry(java.lang.String... args)
                                                      throws NotFoundException

Country of this rule.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setCountry

@Nonnull
public ShippingRule setCountry(com.aspc.dal.dbobj.misc.Country value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryTime

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

setDeliveryTime

@Nonnull
public ShippingRule setDeliveryTime(java.lang.String 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 ShippingRule setInactive(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public ShippingRule setName(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getPriority

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

getRegion

@CheckReturnValue
 @Nullable
public Region getRegion(java.lang.String... args)

findRegion

@CheckReturnValue
 @Nonnull
public final Region findRegion(java.lang.String... args)
                                                    throws NotFoundException

Region of this rule
Paypal country code: https://developer.paypal.com/docs/classic/api /country_codes/

--> Region (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Region

Throws:

NotFoundException - Region was not found

setRegion

@Nonnull
public ShippingRule setRegion(com.aspc.dal.layers.aspc_app.misc.Region value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getService

@CheckReturnValue
 @Nullable
public LogisticsService getService(java.lang.String... args)

findService

@CheckReturnValue
 @Nonnull
public final LogisticsService findService(java.lang.String... args)
                                                               throws NotFoundException

Logistics Service.

--> LogisticsService (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

LogisticsService

Throws:

NotFoundException - LogisticsService was not found

setService

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

Throws:

java.lang.Exception

getState

@CheckReturnValue
 @Nullable
public StateRegion getState(java.lang.String... args)

findState

@CheckReturnValue
 @Nonnull
public final StateRegion findState(java.lang.String... args)
                                                        throws NotFoundException

State of the rule.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setState

@Nonnull
public ShippingRule setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getSuburb

@CheckReturnValue
 @Nullable
public Suburb getSuburb(java.lang.String... args)

findSuburb

@CheckReturnValue
 @Nonnull
public final Suburb findSuburb(java.lang.String... args)
                                                    throws NotFoundException

Suburb of the rule.

--> Suburb (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Suburb

Throws:

NotFoundException - Suburb was not found

setSuburb

@Nonnull
public ShippingRule setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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

toString

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

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description