com.aspc.Layers.aspc_app.Purchase

Class PurchaseItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Purchase.PurchaseItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

PurchaseProductItem

public class PurchaseItem
extends ChargeItem

InvoiceItem is a Generic DBObject.

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

Since:

November 10, 2003, 3:11 PM

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 PurchaseItem
static java.lang.String	DBCLASS_NAME PurchaseItem

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
PurchaseItem(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 void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extCheckReadAccess() Additional access checking for READ access of this object.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for the fields.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
ProductItem	findChargeitem(java.lang.String... args) The associated charge item.
Invoice	findInvoiceId(java.lang.String... args) Invoice Id.
InvoiceItem	findInvoiceItemId(java.lang.String... args) Invoice Item Id.
Job	findJob(java.lang.String... args) Job that this purchase is based upon.
Purchase	findPurchaseId(java.lang.String... args) Associated Purchase.
SupplierQuoteItem	findSupplierQuoteItem(java.lang.String... args) Links to a supplier Quote Item to be purchased.
ProductItem	getChargeitem(java.lang.String... args)
Invoice	getInvoiceId(java.lang.String... args)
InvoiceItem	getInvoiceItemId(java.lang.String... args)
Job	getJob(java.lang.String... args)
Purchase	getPurchase()
Purchase	getPurchaseId(java.lang.String... args)
SupplierQuoteItem	getSupplierQuoteItem(java.lang.String... args)
protected boolean	isModifiableWhenLocked(DBField field)
PurchaseItem	setChargeitem(com.aspc.dal.layers.aspc_app.task.ProductItem value, java.lang.String... args)
PurchaseItem	setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
PurchaseItem	setInvoiceItemId(com.aspc.dal.layers.aspc_app.invoice.InvoiceItem value, java.lang.String... args)
PurchaseItem	setJob(com.aspc.dal.layers.aspc_app.task.Job value, java.lang.String... args)
PurchaseItem	setPurchaseId(com.aspc.dal.layers.aspc_app.purchase.Purchase value, java.lang.String... args)
PurchaseItem	setSupplierQuoteItem(com.aspc.dal.layers.aspc_app.purchase.SupplierQuoteItem value, java.lang.String... args)

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

copyIncludeField, extAutoEnterCreate, extCopy, extFixUp, extIsMandatory, extPreValidate, findAccount, findAdjPriceCheckedBy, findAdjPriceReason, findCalcPriceMatrix, findChargeItemStatus, findChargeItemType, findEnteredBy, findExportFg, findKey, findOwnerBusUnit, findRecurringBase, findTaxCodeId, getAccount, getAdjPriceCheckedBy, getAdjPriceCheckedNotes, getAdjPriceReason, getAdjPriceReasonNotes, getAdjTotalPrice, getAdjTotalPriceIncludingTax, getAdjUnitPrice, getAdjUnitPriceExcludingTax, getAdjUnitPriceIncludingTax, getBackOrdered, getCalcPriceMatrix, getCalcUnitPriceExcludingTax, getChargeItemStatus, getChargeItemType, getCode, getDescription, getDiscountRate, getEnteredBy, getEnteredTime, getExportedTime, getExportFg, getID, getItemCode, getMyobImportTime, getNotes, getOrdered, getOwnerBusUnit, getQty, getRecurringBase, getRoyalties, getTaxCodeId, getTaxRate, getTotalDiscount, getTotalPriceExcludingTax, getTotalPriceIncludingTax, getTotalRoyalties, getTotalTax, getUnitMeasure, getUnitPrice, getUnitPriceDisplay, getUnitPriceDisplayExcludingTax, getUnitPriceDisplayIncludingTax, getUnitPriceExcludingTax, getUnitPriceIncludingTax, hasReadAccess, isAdjPriceChecked, isAdjPriceReasonRequired, isAdjTotalPriceIncludesTax, isAdjUnitPriceIncludesTax, isAdjustItem, isMonthlyRecurring, isNeedToBeCloned, isUnitPriceIncludesTax, makeQuery, setAccount, setAdjPriceChecked, setAdjPriceCheckedBy, setAdjPriceCheckedNotes, setAdjPriceReason, setAdjPriceReasonNotes, setAdjPriceReasonRequired, setAdjTotalPrice, setAdjTotalPriceIncludesTax, setAdjTotalPriceIncludingTax, setAdjUnitPrice, setAdjUnitPriceIncludesTax, setAdjustItem, setBackOrdered, setChargeItemStatus, setCode, setDescription, setDiscountRate, setEnteredBy, setEnteredTime, setExportedTime, setExportFg, setID, setItemCode, setMonthlyRecurring, setMyobImportTime, setNotes, setOrdered, setOwnerBusUnit, setQty, setRecurringBase, setTaxCodeId, setTaxRate, setUnitMeasure, setUnitPrice, setUnitPriceExcludingTax, setUnitPriceIncludesTax, setUnitPriceIncludingTax

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, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

PurchaseItem

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

PurchaseItem

Constructor Detail

PurchaseItem

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

getChargeitem

@CheckReturnValue
 @Nullable
public ProductItem getChargeitem(java.lang.String... args)

findChargeitem

@CheckReturnValue
 @Nonnull
public final ProductItem findChargeitem(java.lang.String... args)
                                                             throws NotFoundException

The associated charge item.

--> ProductItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductItem

Throws:

NotFoundException - ProductItem was not found

setChargeitem

@Nonnull
public PurchaseItem setChargeitem(com.aspc.dal.layers.aspc_app.task.ProductItem value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getInvoiceId

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

findInvoiceId

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

Invoice Id.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setInvoiceId

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

Throws:

java.lang.Exception

getInvoiceItemId

@CheckReturnValue
 @Nullable
public InvoiceItem getInvoiceItemId(java.lang.String... args)

findInvoiceItemId

@CheckReturnValue
 @Nonnull
public final InvoiceItem findInvoiceItemId(java.lang.String... args)
                                                                throws NotFoundException

Invoice Item Id.

--> InvoiceItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceItem

Throws:

NotFoundException - InvoiceItem was not found

setInvoiceItemId

@Nonnull
public PurchaseItem setInvoiceItemId(com.aspc.dal.layers.aspc_app.invoice.InvoiceItem 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 that this purchase is based upon.

--> Job (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Job

Throws:

NotFoundException - Job was not found

setJob

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

Throws:

java.lang.Exception

getPurchaseId

@CheckReturnValue
 @Nullable
public Purchase getPurchaseId(java.lang.String... args)

findPurchaseId

@CheckReturnValue
 @Nonnull
public final Purchase findPurchaseId(java.lang.String... args)
                                                          throws NotFoundException

Associated Purchase.

--> Purchase (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Purchase

Throws:

NotFoundException - Purchase was not found

setPurchaseId

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

Throws:

java.lang.Exception

getSupplierQuoteItem

@CheckReturnValue
 @Nullable
public SupplierQuoteItem getSupplierQuoteItem(java.lang.String... args)

findSupplierQuoteItem

@CheckReturnValue
 @Nonnull
public final SupplierQuoteItem findSupplierQuoteItem(java.lang.String... args)
                                                                          throws NotFoundException

Links to a supplier Quote Item to be purchased.

--> SupplierQuoteItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SupplierQuoteItem

Throws:

NotFoundException - SupplierQuoteItem was not found

setSupplierQuoteItem

@Nonnull
public PurchaseItem setSupplierQuoteItem(com.aspc.dal.layers.aspc_app.purchase.SupplierQuoteItem value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getPurchase

public Purchase getPurchase()

Returns:

the value

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 ChargeItem

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

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class ChargeItem

Parameters:

field - The field to check

Returns:

true if the field affects others when changed

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Additional access checking for READ access of this object.

Overrides:

extCheckReadAccess in class DBObject

Throws:

DBAccessException - No access to READ

See Also:

DBObject.checkReadAccess()

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

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

extGetDerivedValue

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

Calculate the derived value for the fields.

Overrides:

extGetDerivedValue in class ChargeItem

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

isModifiableWhenLocked

protected boolean isModifiableWhenLocked(DBField field)

Parameters:

field - The field

Returns:

the value