com.aspc.cms.cart

Class PaymentDetails

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.cart.PaymentDetails

All Implemented Interfaces:

SecondaryCacheGroup

public class PaymentDetails
extends DBObject

PayPal Payment details.

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

Since:

30 August 2013

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 PayPal Payment details
static java.lang.String	DBCLASS_NAME PayPal Payment details

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
PaymentDetails(DBClass def, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static PaymentDetails	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.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
static PaymentDetails	findKey(DataSource ds, int key) Find the target for this class by the primary key
ShippingRule	findShippingRule(java.lang.String... args) Shipping Rule used for this payment.
java.lang.String	getBillingCity(java.lang.String... args)
java.lang.String	getBillingCountry(java.lang.String... args)
java.lang.String	getBillingName(java.lang.String... args)
java.lang.String	getBillingPhone(java.lang.String... args)
java.lang.String	getBillingPostcode(java.lang.String... args)
java.lang.String	getBillingState(java.lang.String... args)
java.lang.String	getBillingStreet1(java.lang.String... args)
java.lang.String	getBillingStreet2(java.lang.String... args)
java.lang.String	getBillingTo(java.lang.String... args)
double	getHandlingTotal(java.lang.String... args)
int	getID(java.lang.String... args)
double	getInsuranceTotal(java.lang.String... args)
double	getItemTotal(java.lang.String... args)
java.lang.String	getNote(java.lang.String... args)
double	getOrderTotal(java.lang.String... args)
double	getShippingDiscount(java.lang.String... args)
ShippingRule	getShippingRule(java.lang.String... args)
java.lang.String	getShippingTo(java.lang.String... args)
double	getShippingTotal(java.lang.String... args)
java.lang.String	getShipToCity(java.lang.String... args)
java.lang.String	getShipToCountry(java.lang.String... args)
java.lang.String	getShipToName(java.lang.String... args)
java.lang.String	getShipToPhone(java.lang.String... args)
java.lang.String	getShipToPostcode(java.lang.String... args)
java.lang.String	getShipToState(java.lang.String... args)
java.lang.String	getShipToStreet1(java.lang.String... args)
java.lang.String	getShipToStreet2(java.lang.String... args)
double	getTaxTotal(java.lang.String... args)
static DBQuery<PaymentDetails>	makeQuery(DataSource ds) Make a new QUERY for this class.
PaymentDetails	setBillingCity(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingCountry(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingName(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingPhone(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingPostcode(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingState(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingStreet1(java.lang.String value, java.lang.String... args)
PaymentDetails	setBillingStreet2(java.lang.String value, java.lang.String... args)
PaymentDetails	setHandlingTotal(double value, java.lang.String... args)
PaymentDetails	setID(int value, java.lang.String... args)
PaymentDetails	setInsuranceTotal(double value, java.lang.String... args)
PaymentDetails	setItemTotal(double value, java.lang.String... args)
PaymentDetails	setNote(java.lang.String value, java.lang.String... args)
PaymentDetails	setOrderTotal(double value, java.lang.String... args)
PaymentDetails	setShippingDiscount(double value, java.lang.String... args)
PaymentDetails	setShippingRule(com.aspc.dal.cms.cart.ShippingRule value, java.lang.String... args)
PaymentDetails	setShippingTotal(double value, java.lang.String... args)
PaymentDetails	setShipToCity(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToCountry(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToName(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToPhone(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToPostcode(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToState(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToStreet1(java.lang.String value, java.lang.String... args)
PaymentDetails	setShipToStreet2(java.lang.String value, java.lang.String... args)
PaymentDetails	setTaxTotal(double 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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, 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

PayPal Payment details

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

PayPal Payment details

Constructor Detail

PaymentDetails

public PaymentDetails(DBClass def,
                      DataSource dataSource)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getID

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

setID

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

Throws:

java.lang.Exception

getBillingCity

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

setBillingCity

@Nonnull
public PaymentDetails setBillingCity(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getBillingCountry

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

setBillingCountry

@Nonnull
public PaymentDetails setBillingCountry(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getBillingName

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

setBillingName

@Nonnull
public PaymentDetails setBillingName(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getBillingPhone

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

setBillingPhone

@Nonnull
public PaymentDetails setBillingPhone(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getBillingPostcode

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

setBillingPostcode

@Nonnull
public PaymentDetails setBillingPostcode(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getBillingState

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

setBillingState

@Nonnull
public PaymentDetails setBillingState(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getBillingStreet1

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

setBillingStreet1

@Nonnull
public PaymentDetails setBillingStreet1(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getBillingStreet2

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

setBillingStreet2

@Nonnull
public PaymentDetails setBillingStreet2(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getBillingTo

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

getHandlingTotal

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

setHandlingTotal

@Nonnull
public PaymentDetails setHandlingTotal(double value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getInsuranceTotal

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

setInsuranceTotal

@Nonnull
public PaymentDetails setInsuranceTotal(double value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getItemTotal

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

setItemTotal

@Nonnull
public PaymentDetails setItemTotal(double value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getNote

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

setNote

@Nonnull
public PaymentDetails setNote(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getOrderTotal

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

setOrderTotal

@Nonnull
public PaymentDetails setOrderTotal(double value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getShipToCity

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

setShipToCity

@Nonnull
public PaymentDetails setShipToCity(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getShipToCountry

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

setShipToCountry

@Nonnull
public PaymentDetails setShipToCountry(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getShipToName

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

setShipToName

@Nonnull
public PaymentDetails setShipToName(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getShipToPhone

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

setShipToPhone

@Nonnull
public PaymentDetails setShipToPhone(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getShipToPostcode

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

setShipToPostcode

@Nonnull
public PaymentDetails setShipToPostcode(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getShipToState

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

setShipToState

@Nonnull
public PaymentDetails setShipToState(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getShipToStreet1

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

setShipToStreet1

@Nonnull
public PaymentDetails setShipToStreet1(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getShipToStreet2

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

setShipToStreet2

@Nonnull
public PaymentDetails setShipToStreet2(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getShippingDiscount

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

setShippingDiscount

@Nonnull
public PaymentDetails setShippingDiscount(double value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getShippingRule

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

findShippingRule

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

Shipping Rule used for this payment.

--> ShippingRule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

ShippingRule

Throws:

NotFoundException - ShippingRule was not found

setShippingRule

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

Throws:

java.lang.Exception

getShippingTo

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

getShippingTotal

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

setShippingTotal

@Nonnull
public PaymentDetails setShippingTotal(double value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getTaxTotal

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

setTaxTotal

@Nonnull
public PaymentDetails setTaxTotal(double value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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