com.dns

Class Invoice

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.Invoice

com.dns.Invoice

All Implemented Interfaces:

SecondaryCacheGroup

public class Invoice
extends Invoice

Task is a
Generic DBObject.

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

Since:

Apr 14 2010

Author:

anitha

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

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

DBCLASS_GID, DBCLASS_NAME

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
Contact	findBillToPurchaser(java.lang.String... args) bill to purchaser.
java.lang.Object	findEmailTo(java.lang.String... args) Email To.
Contact	findEmailToContact1(java.lang.String... args) Email To Contact1.
Contact	findEmailToContact2(java.lang.String... args) Email To Contact2.
Contact	getBillToPurchaser(java.lang.String... args)
java.lang.Object	getEmailTo(java.lang.String... args)
Contact	getEmailToContact1(java.lang.String... args)
Contact	getEmailToContact2(java.lang.String... args)
double	getProfit(java.lang.String... args)
java.lang.String	getProfitPercentage(java.lang.String... args)
double	getProviderPrice(java.lang.String... args)
java.lang.String	getReportList(java.lang.String... args)
java.lang.String	getStatementMemo(java.lang.String... args)
Invoice	setBillToPurchaser(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Invoice	setEmailTo(java.lang.Object value, java.lang.String... args)

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

adjust, calBalance, calcBillTo, calcSubscriptionEndDate, calTotalPaid, cancelPO, copyIncludeField, create, displayName, extAutoEnterCreate, extCheckCreateAccess, extCheckModifyAccess, extCheckModifyAccess, extCopy, extDelete, extFixUp, extIsMandatory, extIsOnChange, extPreSaveRecord, extPreValidate, extValidateRecord, findBillTo, findBillToCountry, findBillToState, findCalcPriceMatrixRateCategory, findClient, findCreditInvoiceRefundInv, findDeliveryCountry, findDeliveryMethod, findDeliveryState, findEnteredBy, findExportFg, findInquirySource, findJournalSet, findKey, findNextInvoice, findOwnerBusUnit, findPaymentTerms, findPreviousInvoice, findPromotionCode, findRefundMethod, findRefundReason, findRenewalCycle, findRenewalMethod, findSaleId, findSalesCycle, findSalesPerson, findStatus, findSubscriptionRenewalMethod, findSubscriptionRenewalPriceMatrix, findSubscriptionStatus, findSubscriptionTerm, findSubscriptionType, generateCreditInvoice, generateJournalSet, generatePO, generateRenewalCycle, generateSubscription, getAmount, getBalance, getBalanceAsOf, getBillTo, getBillToAddress, getBillToCountry, getBillToDisplayName, getBillToName, getBillToPostCode, getBillToState, getBillToSuburbCity, getCalcPriceMatrixRateCategory, getCalcSubscriptionEndDate, getClient, getCreditInvoiceFg, getCreditInvoiceRefundInv, getDateCancelled, getDefaultProductTerm, getDefaultStatus, getDeliveredDate, getDeliveriesMade, getDeliveriesRemaining, getDeliveryAddress, getDeliveryCountry, getDeliveryDueDate, getDeliveryInstructions, getDeliveryMethod, getDeliveryPostCode, getDeliveryState, getDeliverySuburbCity, getDescription, getDisplayShortDesc, getDueDate, getEnteredBy, getEnterTime, getExportedTime, getExportFg, getFxVariance, getGrossAmount, getInquirySource, getInvDate, getInvId, getInvNumber, getItems, getJournalEntries, getJournalTotalIncome, getLastDelivered, getLastDescription, getLastModified, getMyobJobNumber, getNextInvoice, getNotes, getNumDeliveries, getOverdueAmount, getOwnerBusUnit, getPaymentTerms, getPreviousInvoice, getPromotionCode, getRateCategory, getReference, getRefundMethod, getRefundNotes, getRefundReason, getRenewalMethod, getSaleClosingBalance, getSaleId, getSaleOpeningBalance, getSalesCycle, getSalesPerson, getShipToName, getStatus, getSubscription, getSubscriptionCancelledDate, getSubscriptionEndDate, getSubscriptionEndDateAdj, getSubscriptionRenewalMethod, getSubscriptionRenewalPrice, getSubscriptionRenewalPriceMatrix, getSubscriptionStartDate, getSubscriptionStatus, getSubscriptionTerm, getSubscriptionType, getSubscriptionUsers, getTaxAmount, getToPayExcludeOverdue, getTotalApplied, getTotalCost, getTotalCredits, getTotalDebits, getTotalDue, getTotalPaid, getTotalPOT, getTotalProfit, getTotalRefunds, getTotalRoyalties, getTotalSettledCredits, getTotalToPay, getTotalToPayExcludingTax, getTotalTransferredCredits, getTotalTruePaid, getXeroInvoiceId, isAllowRenewalNotices, isCancelled, isCreditInvoice, isCreditNote, isIgnoreJournalCheck, isLocked, isModifiableWhenLocked, isMyobSyncFg, isNotUpdateSubEndDate, isProcessed, isRefunded, isSubscriptionIsFirstPaid, isSubscriptionIsRenewal, isUnlocked, isUserAccountant, makeQuery, scheduleNotices, setBalance, setBillTo, setBillToAddress, setBillToCountry, setBillToName, setBillToPostCode, setBillToState, setBillToSuburbCity, setClient, setCreditInvoiceFg, setCreditInvoiceRefundInv, setDateCancelled, setDefaultProductTerm, setDeliveredDate, setDeliveryAddress, setDeliveryCountry, setDeliveryDueDate, setDeliveryInstructions, setDeliveryMethod, setDeliveryPostCode, setDeliveryState, setDeliverySuburbCity, setDescription, setEnteredBy, setEnterTime, setExportedTime, setExportFg, setFxVariance, setIgnoreJournalCheck, setInquirySource, setInvDate, setInvId, setInvNumber, setLastModified, setMyobJobNumber, setMyobSyncFg, setNotes, setNotUpdateSubEndDate, setOwnerBusUnit, setPaymentTerms, setPromotionCode, setRateCategory, setRefunded, setRefundMethod, setRefundNotes, setRefundReason, setRenewalMethod, setSaleId, setSalesCycle, setSalesPerson, setStatus, setSubscriptionCancelledDate, setSubscriptionEndDate, setSubscriptionEndDateAdj, setSubscriptionStartDate, setSubscriptionStatus, setSubscriptionTerm, setSubscriptionType, setSubscriptionUsers, setUnlocked, setXeroInvoiceId, updateBalance, updateBillToAddress, updateInvoiceNumber, updateProductItems, updateProductItems, updateSubscriptionEndDate, updateSubscriptionEndDate, updateSubStatus

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, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckDeleteAccess, extCheckReadAccess, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

Constructor Detail

Invoice

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

getBillToPurchaser

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

findBillToPurchaser

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

bill to purchaser.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setBillToPurchaser

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

Throws:

java.lang.Exception

getEmailTo

@CheckReturnValue
 @Nullable
public java.lang.Object getEmailTo(java.lang.String... args)

findEmailTo

@CheckReturnValue
 @Nonnull
public final java.lang.Object findEmailTo(java.lang.String... args)
                                                               throws NotFoundException

Email To.

--> EmailTo (String, Searchable)

Parameters:

args - the optional arguments

Returns:

EmailTo

Throws:

NotFoundException - EmailTo was not found

setEmailTo

@Nonnull
public Invoice setEmailTo(java.lang.Object value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getEmailToContact1

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

findEmailToContact1

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

Email To Contact1.

--> Contact (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

getEmailToContact2

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

findEmailToContact2

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

Email To Contact2.

--> Contact (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

getProfit

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

getProfitPercentage

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

getProviderPrice

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

getReportList

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

getStatementMemo

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

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class Invoice

Parameters:

field - The field to get

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

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

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

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class Invoice

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

extValidateField

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class Invoice

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem