com.aspc.Layers.aspc_app.Task

Class Checkout

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.Task

com.aspc.Layers.aspc_app.Task.ChargeableTask

com.aspc.Layers.aspc_app.Task.Sale

com.aspc.Layers.aspc_app.Task.Checkout

All Implemented Interfaces:

SecondaryCacheGroup

public class Checkout
extends Sale

DBOrder is a sale order The sale order.

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 sale order
static java.lang.String	DBCLASS_NAME The sale order

Fields inherited from class com.aspc.Layers.aspc_app.Task.Task

skipAlert, STATUS_ACCEPTED, STATUS_COMPLETED, STATUS_DOLATER, STATUS_ENTERED, STATUS_REJECTED, STATUS_STARTED

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	extCreateInvoice(Invoice invoice, boolean completedTasksOnly) Extends processing of Invoice generation.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected void	extPreSaveRecord() Over ridden method
Contact	findAffiliate(java.lang.String... args) Affiliate of this checkout.
ShoppingCart	findShoppingcart(java.lang.String... args) Linked Shopping Cart.
Contact	getAffiliate(java.lang.String... args)
double	getHandlingTotal(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)
double	getShippingTotal(java.lang.String... args)
ShoppingCart	getShoppingCart() get the linked ShoppingCart
ShoppingCart	getShoppingcart(java.lang.String... args)
double	getTaxTotal(java.lang.String... args)
Checkout	setAffiliate(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Checkout	setHandlingTotal(double value, java.lang.String... args)
Checkout	setInsuranceTotal(double value, java.lang.String... args)
Checkout	setItemTotal(double value, java.lang.String... args)
Checkout	setNote(java.lang.String value, java.lang.String... args)
Checkout	setOrderTotal(double value, java.lang.String... args)
Checkout	setShippingDiscount(double value, java.lang.String... args)
Checkout	setShippingTotal(double value, java.lang.String... args)
Checkout	setShoppingcart(com.aspc.dal.cms.cart.ShoppingCart value, java.lang.String... args)
Checkout	setTaxTotal(double value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.Task.Sale

createInvoice, eventFieldUpdated, extGetDerivedValue, fill, findContract, findInquirySource, findPaymentAccount, findPurchaseStatus, findQuoteId, findRetainerEmailTemplate, findSalesCycle, findSalesPerson, getBalance, getBalanceExcludingTax, getBalancePayable, getCalcLabourLimit, getCapEndDate, getCapExceed, getCapRemain, getCapStartDate, getClientOrderNo, getContract, getCostOfSale, getDaysLeftCurrentTerm, getEstCredit, getEstLabourDaysCredit, getInquirySource, getInvoiceNumbers, getLabourHoursRemainThisCap, getLabourHoursRemainThisMonth, getLabourHoursUsedThisPeriod, getLabourInDays, getLabourInHours, getLabourInHoursAdjusted, getLabourLimit, getMinimumTermDate, getNotCompleted, getOverdueAmount, getPaid, getPaymentAccount, getPoDate, getPoExtensionDate, getPrePaidDaysLeft, getPrePaidEnd, getPrePaidHoursLeft, getPrePaidStart, getPurchaseStatus, getQuoteId, getReadyToInvoice, getRetainerCapEnds, getRetainerCapStarts, getRetainerEmailTemplate, getRetainerJobType, getRetainerRecipients, getSalesCycle, getSalesPerson, getSumTotals, getToPay, getToPayExcludeOverdue, getTotalLabourHoursRemain, getTotalProductLabourHours, isBalancePayableWarning, isCapStartToday, isInvoiced, isLabourHoursLow, isLabourHoursOver, isNotCompletedWarning, isReadyToInvoiceWarning, isSendRetainerEmail, setClientOrderNo, setContract, setInquirySource, setLabourLimit, setMinimumTermDate, setPaymentAccount, setPoDate, setPoExtensionDate, setPrePaidEnd, setPrePaidStart, setPurchaseStatus, setQuoteId, setRetainerEmailTemplate, setRetainerJobType, setSalesCycle, setSalesPerson, setSendRetainerEmail

Methods inherited from class com.aspc.Layers.aspc_app.Task.ChargeableTask

copyChildren, extAutoEnterCreate, extCopy, extFixUp, extIsMandatory, extIsOnChange, extPostSaveRecord, extPreValidate, findAccountManager, findBillTo, findCalcSaleType, findCampaign, findChargeTaxCode, findContact, findCopyFromTemplate, findDefaultLabourRate, findLastCompleteActivity, findLastModifiedActivity, findNextScheduledActivity, findPaymentTerms, findRecipient, findSite, findSiteRegion, findState, findSuburb, getAccountManager, getActivities, getAdjTotalPrice, getBillTo, getCalcAttn, getCalcBillTo, getCalcSaleType, getCampaign, getChargeTaxCode, getChargeTaxRate, getContact, getContactDisplaySiteAddress, getCopyFromTemplate, getCreditSurchargePerc, getCustomerInvoice, getCustomerInvoiceDate, getCustomerPO, getDefaultLabourRate, getDefaultSiteContact, getDeliveryFee, getDiscountRate, getDisplayContact, getDisplaySiteAddress, getDisplaySiteCountry, getDisplaySitePhone, getDisplaySitePostCode, getDisplaySiteState, getDisplaySiteSuburbCity, getJobItems, getLastActionTime, getLastCompleteActivity, getLastModifiedActivity, getLastNoticeNumber, getNextScheduledActivity, getOrderConfirmationNum, getPaymentTerms, getProfit, getProfitPerc, getRecipient, getRecipientName, getReminderComment, getSite, getSiteAddress, getSiteContactMobile, getSiteContactPerson, getSiteContactPhone, getSiteCoordinate, getSiteCountry, getSiteFax, getSiteName, getSiteNotes, getSitePhone, getSitePostcode, getSiteRegion, getSiteState, getSiteSuburbCity, getState, getStatusJournal, getSuburb, getTotalDiscount, getTotalRoyalties, setAccountManager, setAdjTotalPrice, setBillTo, setCampaign, setChargeTaxCode, setChargeTaxRate, setContact, setCopyFromTemplate, setCreditSurchargePerc, setCustomerInvoice, setCustomerInvoiceDate, setCustomerPO, setDefaultLabourRate, setDeliveryFee, setDiscountRate, setOrderConfirmationNum, setPaymentTerms, setRecipient, setReminderComment, setSite, setSiteAddress, setSiteContactMobile, setSiteContactPerson, setSiteContactPhone, setSiteCoordinate, setSiteCountry, setSiteFax, setSiteName, setSiteNotes, setSitePhone, setSitePostcode, setSiteRegion, setSiteState, setSiteSuburbCity, setState, setSuburb, updateProspectCategory

Methods inherited from class com.aspc.Layers.aspc_app.Task.Task

cleanupCurrentNote, copyIncludeField, createFromType, extPreValidateDelete, extSetValue, extValidateField, findAssignTo, findAssignToGroup, findAttachedEmail, findCalcCustomer, findCategory, findCurrentNote, findCurrentNoteRaw, findDependsOn, findEnteredBy, findInitialAssignTo, findInitialNotNullAssignTo, findKey, findLastModifiedBy, findOwner, findOwnerBusUnit, findPredecessorsStatus, findPriority, findRepeatBase, findRepeatNext, findRepeatPrevious, findRequestedBy, findResult, findSchedAmPm, findSeriesPrevious, findSimpleStatus, findStatus, findStatusLastChangedBy, findTemplateType, findType, getActionByDate, getActualDuration, getActualEnd, getActualEndMonth, getActualStart, getAdditionalCharge, getAdditionalCosts, getAdditionalDetails, getAdjActualDuration, getAdjustedCost, getAssignTo, getAssignToDate, getAssignToGroup, getAttachedEmail, getCalcActualDuration, getCalcCustomer, getCalcTotalDuration, getCategory, getCurrentNote, getCurrentNoteRaw, getDependsOn, getDescription, getDisplayBusyTime, getDisplayId, getDisplaySchedTime, getDisplayShortDesc, getDisplayStatus, getDueBy, getDuration, getEndDate, getEnteredBy, getEnterTime, getEnterTimeMonthYear, getEstVSActualHours, getExpectedFinishMonthYear, getFullTextSearchScore, getHtmlDescription, getICalEnd, getICalFullAddress, getICalOrganizer, getICalStart, getID, getInitialAssignTo, getInitialAssignToDate, getInitialNotNullAssignTo, getInitialNotNullAssignToDate, getIssueDate, getLastModifiedBy, getLastModifiedTime, getLinkedJobs, getNextAlert, getNextOverdueAlert, getObseleteNotes, getOwner, getOwnerBusUnit, getPercUntilClosed, getPreAlertDuration, getPredecessorsStatus, getPrimaryType, getPriority, getProperties, getRawSearchText, getReferenceNumber, getReferencesUUID, getRepeatBase, getRepeatedTimezone, getRepeatNext, getRepeatPrevious, getRequestedBy, getResult, getSchedAmPm, getSequence, getSeriesPrevious, getShortDesc, getSimpleStatus, getStartDate, getStatus, getStatusLastChanged, getStatusLastChangedBy, getStatusLastChangedTurnaround, getTags, getTagsLabel, getTagsRaw, getTaskCoverphoto, getTaskfeedBackBad, getTaskfeedBackGood, getTaskfeedbacknotes, getTaskRating, getTaskSeries, getTemplateType, getTimemapDurationField, getTimemapEndTime, getTimemapEndTimeField, getTimemapStartTime, getTimemapStartTimeField, getTmpAttachmentKey, getTotalCost, getTotalLabourCosts, getTotalLabourPrice, getTotalLabourPriceExcTax, getTotalPriceExcTax, getTotalPriceIncTax, getTotalProductCosts, getTotalProductPrice, getTotalProductPriceExcTax, getTotalProfit, getTotalProfitPerc, getTotalRelatedCosts, getTotalTax, getType, getUntouchedTaskSeries, getUUID, getValueForPublic, getWeakReferencesUUID, handleEvent, hasReadAccess, isAllPredecessorsClosed, isApplicableTo, isCategoryRequired, isChangedByUser, isCheckPredecessorsClosed, isChildNode, isClosed, isContains, isCurrent, isDescendantNode, isDirectory, isDueByExpiresIn, isLockedAssignTo, isLockedStartDate, isMatchesSkillLevel, isMyGroup, isNextAlertDueIn, isNoteRequired, isPublic, isReferenceable, isRepeated, isSameNode, isSendAlert, isTimemapHasEndTime, isVersionable, lastModified, listNodes, makeQuery, makeSearchPlan, processRawTags, setActualEnd, setActualStart, setAdditionalCharge, setAdditionalCosts, setAdditionalDetails, setAdjActualDuration, setAdjustedCost, setAllPredecessorsClosed, setAssignTo, setAssignToDate, setAssignToGroup, setAttachedEmail, setCategory, setCategoryRequired, setChangedByUser, setCurrentNoteRaw, setDependsOn, setDescription, setDueBy, setDuration, setEndDate, setEnteredBy, setEnterTime, setID, setInitialAssignTo, setInitialAssignToDate, setIssueDate, setLastModifiedBy, setLastModifiedTime, setLockedAssignTo, setLockedStartDate, setNextAlert, setNextOverdueAlert, setObseleteNotes, setOwner, setOwnerBusUnit, setPercUntilClosed, setPreAlertDuration, setPredecessorsStatus, setPrimaryType, setPriority, setProperties, setRawSearchText, setReferenceable, setReferenceNumber, setReferencesUUID, setRepeatBase, setRepeated, setRepeatedTimezone, setRepeatNext, setRepeatPrevious, setRequestedBy, setResult, setSchedAmPm, setSendAlert, setSequence, setSeriesPrevious, setShortDesc, setSimpleStatus, setStartDate, setStatus, setStatusLastChanged, setStatusLastChangedBy, setTags, setTagsRaw, setTaskCoverphoto, setTaskfeedBackBad, setTaskfeedBackGood, setTaskfeedbacknotes, setTaskRating, setTemplateType, setTmpAttachmentKey, setType, setUUID, setVersionable, setWeakReferencesUUID, toString, updateStatus, vDisplayName, vName

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, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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, 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

The sale order

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The sale order

Constructor Detail

Checkout

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

getAffiliate

@CheckReturnValue
 @Nullable
public Contact getAffiliate(java.lang.String... args)

findAffiliate

@CheckReturnValue
 @Nonnull
public final Contact findAffiliate(java.lang.String... args)
                                                        throws NotFoundException

Affiliate of this checkout.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setAffiliate

@Nonnull
public Checkout setAffiliate(com.aspc.dal.dbobj.contact.Contact value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getHandlingTotal

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

setHandlingTotal

@Nonnull
public Checkout 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 Checkout 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 Checkout 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 Checkout 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 Checkout setOrderTotal(double 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 Checkout setShippingDiscount(double value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getShippingTotal

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

setShippingTotal

@Nonnull
public Checkout setShippingTotal(double 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

Linked Shopping Cart.

--> ShoppingCart (String, Mandatory, Unique, Searchable)

Parameters:

args - the optional arguments

Returns:

ShoppingCart

Throws:

NotFoundException - ShoppingCart was not found

setShoppingcart

@Nonnull
public Checkout setShoppingcart(com.aspc.dal.cms.cart.ShoppingCart 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 Checkout setTaxTotal(double value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

extPreSaveRecord

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

Description copied from class: ChargeableTask

Over ridden method

Overrides:

extPreSaveRecord in class Sale

Throws:

java.lang.Exception - a serious problem

extGetDerivedGlobalKey

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

Description copied from class: Sale

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class Sale

Parameters:

field - The field to get

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

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extCreateInvoice

public void extCreateInvoice(Invoice invoice,
                             boolean completedTasksOnly)
                      throws java.lang.Exception

Description copied from class: Sale

Extends processing of Invoice generation.

Overrides:

extCreateInvoice in class Sale

Parameters:

invoice - - Invoice being generated

Throws:

java.lang.Exception - a serious problem

getShoppingCart

public ShoppingCart getShoppingCart()
                             throws java.lang.Exception

get the linked ShoppingCart

Returns:

ShoppingCart or null if not find

Throws:

java.lang.Exception - a serious problem.