com.aspc.Layers.aspc_app.Purchase

Class Purchase

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Purchase.Purchase

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Purchase, Purchase

public class Purchase
extends DBObject

Task is a
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

Since:

November 10, 2003, 9:41 AM

Author:

Jason McGrath

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 General purchase details are added on this screen.
static java.lang.String	DBCLASS_NAME General purchase details are added on this screen.

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
void	adjust()
double	calBalance() Calculates the current balance
static Purchase	create(MutableDataSource mds) Make a new instance of this class.
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 void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extFixUp() The extended fix up routine for known problems.
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 void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
Contact	findDeliverTo(java.lang.String... args) Company to deliver the goods to.
Country	findDeliveryCountry(java.lang.String... args) Country to delivery to.
java.lang.Object	findDeliveryMethod(java.lang.String... args) Delivery method for supply of goods.
StateRegion	findDeliveryState(java.lang.String... args) State to deliver to.
Person	findEnteredBy(java.lang.String... args) Entered By.
DBTriStateOption	findExportFg(java.lang.String... args) Indicates if this Purchase is ready for exporting.
Invoice	findInvoiceId(java.lang.String... args) Invoice that this purchase was generated from.
Job	findJob(java.lang.String... args) job field for displaying the purchase orders.
static Purchase	findKey(DataSource ds, int key) Find the target for this class by the primary key
Company	findOwnerBusUnit(java.lang.String... args) Business unit that owns this entry.
java.lang.Object	findPaymentTerms(java.lang.String... args) Payment terms for this supplier can be selected from a drop down list.
Product	findReOrderProduct(java.lang.String... args) ReOrder Product.
Person	findSalesPerson(java.lang.String... args) Sales Person.
PurchaseStatus	findStatus(java.lang.String... args) The default status is Draft and others can be selected from a drop down list.
Contact	findSupplierId(java.lang.String... args) Details of the Supplier of the product.
double	getAmount(java.lang.String... args)
double	getBalance(java.lang.String... args)
java.util.Date	getDateCompleted(java.lang.String... args)
DBObject	getDefaultStatus()
Contact	getDeliverTo(java.lang.String... args)
java.lang.String	getDeliverToName(java.lang.String... args)
java.lang.String	getDeliveryAddress(java.lang.String... args)
Country	getDeliveryCountry(java.lang.String... args)
java.lang.Object	getDeliveryMethod(java.lang.String... args)
java.lang.String	getDeliveryPostCode(java.lang.String... args)
StateRegion	getDeliveryState(java.lang.String... args)
java.lang.String	getDeliverySuburbCity(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnteredTime(java.lang.String... args)
java.util.Date	getExportedTime(java.lang.String... args)
DBTriStateOption	getExportFg(java.lang.String... args)
java.lang.String	getFromJob(java.lang.String... args)
double	getGrossAmount(java.lang.String... args)
int	getID(java.lang.String... args)
Invoice	getInvoiceId(java.lang.String... args)
DBObject[]	getItems()
Job	getJob(java.lang.String... args)
java.lang.String	getMemo(java.lang.String... args)
java.lang.String	getMyobJobNumber(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
java.lang.Object	getPaymentTerms(java.lang.String... args)
java.util.Date	getPromisedDate(java.lang.String... args)
java.util.Date	getPurchaseDate(java.lang.String... args)
java.lang.String	getPurchaseNumber(java.lang.String... args)
Product	getReOrderProduct(java.lang.String... args)
Person	getSalesPerson(java.lang.String... args)
PurchaseStatus	getStatus(java.lang.String... args)
Contact	getSupplierId(java.lang.String... args)
double	getTaxAmount(java.lang.String... args)
double	getTotalCredits(java.lang.String... args)
double	getTotalDebits(java.lang.String... args)
double	getTotalDiscount(java.lang.String... args)
double	getTotalDue(java.lang.String... args)
double	getTotalPaid(java.lang.String... args)
java.lang.String	getVendorInvoiceNumber(java.lang.String... args)
java.lang.String	getXeroPurchaseId(java.lang.String... args)
boolean	hasMultiPayments(java.lang.String... args)
boolean	isAddedFromJob(java.lang.String... args)
boolean	isCancelled()
boolean	isLocked()
protected boolean	isModifiableWhenLocked(DBField field)
static DBQuery<Purchase>	makeQuery(DataSource ds) Make a new QUERY for this class.
Purchase	setAddedFromJob(boolean value, java.lang.String... args)
Purchase	setBalance(double value, java.lang.String... args)
Purchase	setDateCompleted(java.util.Date value, java.lang.String... args)
Purchase	setDeliverTo(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Purchase	setDeliverToName(java.lang.String value, java.lang.String... args)
Purchase	setDeliveryAddress(java.lang.String value, java.lang.String... args)
Purchase	setDeliveryCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Purchase	setDeliveryMethod(java.lang.Object value, java.lang.String... args)
Purchase	setDeliveryPostCode(java.lang.String value, java.lang.String... args)
Purchase	setDeliveryState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)
Purchase	setDeliverySuburbCity(java.lang.String value, java.lang.String... args)
Purchase	setDescription(java.lang.String value, java.lang.String... args)
Purchase	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
Purchase	setEnteredTime(java.util.Date value, java.lang.String... args)
Purchase	setExportedTime(java.util.Date value, java.lang.String... args)
Purchase	setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
Purchase	setFromJob(java.lang.String value, java.lang.String... args)
Purchase	setID(int value, java.lang.String... args)
Purchase	setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
Purchase	setJob(com.aspc.dal.layers.aspc_app.task.Job value, java.lang.String... args)
Purchase	setMemo(java.lang.String value, java.lang.String... args)
Purchase	setMyobJobNumber(java.lang.String value, java.lang.String... args)
Purchase	setNotes(java.lang.String value, java.lang.String... args)
Purchase	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
Purchase	setPaymentTerms(java.lang.Object value, java.lang.String... args)
Purchase	setPromisedDate(java.util.Date value, java.lang.String... args)
Purchase	setPurchaseDate(java.util.Date value, java.lang.String... args)
Purchase	setPurchaseNumber(java.lang.String value, java.lang.String... args)
Purchase	setReOrderProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
Purchase	setSalesPerson(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
Purchase	setStatus(com.aspc.dal.layers.aspc_app.purchase.PurchaseStatus value, java.lang.String... args)
Purchase	setSupplierId(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Purchase	setVendorInvoiceNumber(java.lang.String value, java.lang.String... args)
Purchase	setXeroPurchaseId(java.lang.String value, java.lang.String... args)
void	updateBalance()
protected void	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, 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

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

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

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

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

getID

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

setID

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

Throws:

java.lang.Exception

getAmount

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

getBalance

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

setBalance

@Nonnull
public Purchase setBalance(double value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getDateCompleted

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

setDateCompleted

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

Throws:

java.lang.Exception

getDeliverTo

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

findDeliverTo

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

Company to deliver the goods to. Default company is your own.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setDeliverTo

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

Throws:

java.lang.Exception

getDeliverToName

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

setDeliverToName

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

Throws:

java.lang.Exception

getDeliveryAddress

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

setDeliveryAddress

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

Throws:

java.lang.Exception

getDeliveryCountry

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

findDeliveryCountry

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

Country to delivery to.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setDeliveryCountry

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

Throws:

java.lang.Exception

getDeliveryMethod

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

findDeliveryMethod

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

Delivery method for supply of goods.

--> DeliveryMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliveryMethod

Throws:

NotFoundException - DeliveryMethod was not found

setDeliveryMethod

@Nonnull
public Purchase setDeliveryMethod(java.lang.Object value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryPostCode

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

setDeliveryPostCode

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

Throws:

java.lang.Exception

getDeliveryState

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

findDeliveryState

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

State to deliver to.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setDeliveryState

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

Throws:

java.lang.Exception

getDeliverySuburbCity

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

setDeliverySuburbCity

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

Throws:

java.lang.Exception

getDescription

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

setDescription

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

Throws:

java.lang.Exception

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public Purchase setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredTime

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

setEnteredTime

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

Throws:

java.lang.Exception

getExportFg

@CheckReturnValue
 @Nullable
public DBTriStateOption getExportFg(java.lang.String... args)

findExportFg

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findExportFg(java.lang.String... args)
                                                                throws NotFoundException

Indicates if this Purchase is ready for exporting.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setExportFg

@Nonnull
public Purchase setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getExportedTime

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

setExportedTime

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

Throws:

java.lang.Exception

getFromJob

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

setFromJob

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

Throws:

java.lang.Exception

getGrossAmount

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

hasMultiPayments

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

getInvoiceId

@CheckReturnValue
 @Nullable
public Invoice getInvoiceId(java.lang.String... args)

findInvoiceId

@CheckReturnValue
 @Nonnull
public final Invoice findInvoiceId(java.lang.String... args)
                                                        throws NotFoundException

Invoice that this purchase was generated from.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setInvoiceId

@Nonnull
public Purchase setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isAddedFromJob

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

setAddedFromJob

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

Throws:

java.lang.Exception

getJob

@CheckReturnValue
 @Nullable
public Job getJob(java.lang.String... args)

findJob

@CheckReturnValue
 @Nonnull
public final Job findJob(java.lang.String... args)
                                              throws NotFoundException

job field for displaying the purchase orders.

--> Job (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Job

Throws:

NotFoundException - Job was not found

setJob

@Nonnull
public Purchase setJob(com.aspc.dal.layers.aspc_app.task.Job value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getMemo

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

setMemo

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

Throws:

java.lang.Exception

getMyobJobNumber

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

setMyobJobNumber

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

Throws:

java.lang.Exception

getNotes

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

setNotes

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

Throws:

java.lang.Exception

getOwnerBusUnit

@CheckReturnValue
 @Nullable
public Company getOwnerBusUnit(java.lang.String... args)

findOwnerBusUnit

@CheckReturnValue
 @Nonnull
public final Company findOwnerBusUnit(java.lang.String... args)
                                                           throws NotFoundException

Business unit that owns this entry.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business Unit

Throws:

NotFoundException - Business was not found

setOwnerBusUnit

@Nonnull
public Purchase setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentTerms

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

findPaymentTerms

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

Payment terms for this supplier can be selected from a drop down list.

--> PaymentTerms (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentTerms

Throws:

NotFoundException - PaymentTerms was not found

setPaymentTerms

@Nonnull
public Purchase setPaymentTerms(java.lang.Object value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getPromisedDate

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

setPromisedDate

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

Throws:

java.lang.Exception

getPurchaseDate

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

setPurchaseDate

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

Throws:

java.lang.Exception

getPurchaseNumber

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

setPurchaseNumber

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

Throws:

java.lang.Exception

getReOrderProduct

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

findReOrderProduct

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

ReOrder Product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setReOrderProduct

@Nonnull
public Purchase setReOrderProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSalesPerson

@CheckReturnValue
 @Nullable
public Person getSalesPerson(java.lang.String... args)

findSalesPerson

@CheckReturnValue
 @Nonnull
public final Person findSalesPerson(java.lang.String... args)
                                                         throws NotFoundException

Sales Person.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setSalesPerson

@Nonnull
public Purchase setSalesPerson(com.aspc.dal.layers.aspc_app.contact.Person value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public PurchaseStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final PurchaseStatus findStatus(java.lang.String... args)
                                                            throws NotFoundException

The default status is Draft and others can be selected from a drop down list.

--> PurchaseStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PurchaseStatus

Throws:

NotFoundException - PurchaseStatus was not found

setStatus

@Nonnull
public Purchase setStatus(com.aspc.dal.layers.aspc_app.purchase.PurchaseStatus value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getSupplierId

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

findSupplierId

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

Details of the Supplier of the product.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setSupplierId

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

Throws:

java.lang.Exception

getTaxAmount

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

getTotalCredits

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

getTotalDebits

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

getTotalDiscount

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

getTotalDue

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

getTotalPaid

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

getVendorInvoiceNumber

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

setVendorInvoiceNumber

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

Throws:

java.lang.Exception

getXeroPurchaseId

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

setXeroPurchaseId

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

Throws:

java.lang.Exception

create

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

isLocked

public boolean isLocked()

Returns:

the value

isCancelled

public boolean isCancelled()

Returns:

the value

getDefaultStatus

public DBObject getDefaultStatus()
                          throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()

isModifiableWhenLocked

protected boolean isModifiableWhenLocked(DBField field)

Parameters:

field - The field

Returns:

the value

extGetDerivedValue

@CheckReturnValue
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 DBObject

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

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A serious problem

adjust

public void adjust()
            throws java.lang.Exception

Throws:

java.lang.Exception - Exception A serious problem

updateBalance

public void updateBalance()
                   throws java.lang.Exception

Throws:

java.lang.Exception

calBalance

public double calBalance()
                  throws java.lang.Exception

Calculates the current balance

Returns:

the current balance

Throws:

java.lang.Exception - a serious problem

getItems

public DBObject[] getItems()

Returns:

the value

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

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 DBObject

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

updatePurchaseNumber

protected void updatePurchaseNumber()
                             throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - A serious problem