com.dns

Class Purchase

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Purchase.Purchase

com.dns.Purchase

All Implemented Interfaces:

SecondaryCacheGroup

public class Purchase
extends Purchase

General purchase details are added on this screen. Select New Purchase from the Purchases menu.

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

Author:

Liam

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.Purchase.Purchase

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
Purchase(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
boolean	checkIfAlreadyCreated(ProductItem productItem)
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
BuildingSize	findBuildingSize(java.lang.String... args) Building Size.
Product	findProduct(java.lang.String... args) Product.
Provider	findProvider(java.lang.String... args) Provider.
ProviderPriceMatrix	findProviderMatrix(java.lang.String... args) Provider Matrix.
BuildingSize	getBuildingSize(java.lang.String... args)
java.util.Date	getDnsPurchaseDate(java.lang.String... args)
java.util.Date	getInspectionTime(java.lang.String... args)
java.lang.String	getPreviousSuburb(java.lang.String... args)
java.util.Date	getPrevSuburbInspTime(java.lang.String... args)
Product	getProduct(java.lang.String... args)
double	getProfit(java.lang.String... args)
java.lang.String	getProfitPercentage(java.lang.String... args)
Provider	getProvider(java.lang.String... args)
ProviderPriceMatrix	getProviderMatrix(java.lang.String... args)
boolean	isSplitBuildPestReport(java.lang.String... args)
Purchase	setBuildingSize(com.dns.dal.BuildingSize value, java.lang.String... args)
Purchase	setDnsPurchaseDate(java.util.Date value, java.lang.String... args)
Purchase	setInspectionTime(java.util.Date value, java.lang.String... args)
Purchase	setProduct(com.dns.dal.Product value, java.lang.String... args)
Purchase	setProvider(com.dns.dal.Provider value, java.lang.String... args)
Purchase	setProviderMatrix(com.dns.dal.ProviderPriceMatrix value, java.lang.String... args)
Purchase	setSplitBuildPestReport(boolean value, java.lang.String... args)

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

adjust, calBalance, create, extCheckCreateAccess, extCheckModifyAccess, extFixUp, extPreValidate, findDeliverTo, findDeliveryCountry, findDeliveryMethod, findDeliveryState, findEnteredBy, findExportFg, findInvoiceId, findJob, findKey, findOwnerBusUnit, findPaymentTerms, findReOrderProduct, findSalesPerson, findStatus, findSupplierId, getAmount, getBalance, getDateCompleted, getDefaultStatus, getDeliverTo, getDeliverToName, getDeliveryAddress, getDeliveryCountry, getDeliveryMethod, getDeliveryPostCode, getDeliveryState, getDeliverySuburbCity, getDescription, getEnteredBy, getEnteredTime, getExportedTime, getExportFg, getFromJob, getGrossAmount, getID, getInvoiceId, getItems, getJob, getMemo, getMyobJobNumber, getNotes, getOwnerBusUnit, getPaymentTerms, getPromisedDate, getPurchaseDate, getPurchaseNumber, getReOrderProduct, getSalesPerson, getStatus, getSupplierId, getTaxAmount, getTotalCredits, getTotalDebits, getTotalDiscount, getTotalDue, getTotalPaid, getVendorInvoiceNumber, getXeroPurchaseId, hasMultiPayments, isAddedFromJob, isCancelled, isLocked, isModifiableWhenLocked, makeQuery, setAddedFromJob, setBalance, setDateCompleted, setDeliverTo, setDeliverToName, setDeliveryAddress, setDeliveryCountry, setDeliveryMethod, setDeliveryPostCode, setDeliveryState, setDeliverySuburbCity, setDescription, setEnteredBy, setEnteredTime, setExportedTime, setExportFg, setFromJob, setID, setInvoiceId, setJob, setMemo, setMyobJobNumber, setNotes, setOwnerBusUnit, setPaymentTerms, setPromisedDate, setPurchaseDate, setPurchaseNumber, setReOrderProduct, setSalesPerson, setStatus, setSupplierId, setVendorInvoiceNumber, setXeroPurchaseId, updateBalance, updatePurchaseNumber

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, extCanDeleteDependantObject, extCheckDeleteAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsOnChange, 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

Purchase

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

getBuildingSize

@CheckReturnValue
 @Nullable
public BuildingSize getBuildingSize(java.lang.String... args)

findBuildingSize

@CheckReturnValue
 @Nonnull
public final BuildingSize findBuildingSize(java.lang.String... args)
                                                                throws NotFoundException

Building Size.

--> BuildingSize (String, Searchable)

Parameters:

args - the optional arguments

Returns:

BuildingSize

Throws:

NotFoundException - BuildingSize was not found

setBuildingSize

@Nonnull
public Purchase setBuildingSize(com.dns.dal.BuildingSize value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDnsPurchaseDate

@CheckReturnValue
 @Nullable
public java.util.Date getDnsPurchaseDate(java.lang.String... args)

setDnsPurchaseDate

@Nonnull
public Purchase setDnsPurchaseDate(java.util.Date value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getInspectionTime

@CheckReturnValue
 @Nullable
public java.util.Date getInspectionTime(java.lang.String... args)

setInspectionTime

@Nonnull
public Purchase setInspectionTime(java.util.Date value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getPrevSuburbInspTime

@CheckReturnValue
 @Nullable
public java.util.Date getPrevSuburbInspTime(java.lang.String... args)

getPreviousSuburb

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

getProduct

@CheckReturnValue
 @Nullable
public Product getProduct(java.lang.String... args)

findProduct

@CheckReturnValue
 @Nonnull
public final Product findProduct(java.lang.String... args)
                                                      throws NotFoundException

Product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

@Nonnull
public Purchase setProduct(com.dns.dal.Product value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getProfit

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

getProfitPercentage

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

getProvider

@CheckReturnValue
 @Nullable
public Provider getProvider(java.lang.String... args)

findProvider

@CheckReturnValue
 @Nonnull
public final Provider findProvider(java.lang.String... args)
                                                        throws NotFoundException

Provider.

--> Provider (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Provider

Throws:

NotFoundException - Provider was not found

setProvider

@Nonnull
public Purchase setProvider(com.dns.dal.Provider value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getProviderMatrix

@CheckReturnValue
 @Nullable
public ProviderPriceMatrix getProviderMatrix(java.lang.String... args)

findProviderMatrix

@CheckReturnValue
 @Nonnull
public final ProviderPriceMatrix findProviderMatrix(java.lang.String... args)
                                                                         throws NotFoundException

Provider Matrix.

--> ProviderPriceMatrix (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

ProviderPriceMatrix

Throws:

NotFoundException - ProviderPriceMatrix was not found

setProviderMatrix

@Nonnull
public Purchase setProviderMatrix(com.dns.dal.ProviderPriceMatrix value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isSplitBuildPestReport

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

setSplitBuildPestReport

@Nonnull
public Purchase setSplitBuildPestReport(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class Purchase

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

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 Purchase

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

checkIfAlreadyCreated

public boolean checkIfAlreadyCreated(ProductItem productItem)
                              throws java.lang.Exception

Throws:

java.lang.Exception

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 Purchase

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

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 Purchase

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

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 Purchase

Throws:

java.lang.Exception - a serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class Purchase

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem