com.aspc.Layers.aspc_app.Invoice

Class InvoiceItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Invoice.InvoiceItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

InvoiceActivityItem, InvoiceJobProductItem, InvoiceMembershipItem, InvoiceProductItem

public class InvoiceItem
extends ChargeItem

InvoiceItem is a An item that appears on an invoice.

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

Since:

December 11, 2002, 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 An item that appears on an invoice.
static java.lang.String	DBCLASS_NAME An item that appears on an invoice.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
InvoiceItem(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 void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
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 ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
Activity	findActivity(java.lang.String... args) Activity.
Invoice	findInvoiceId(java.lang.String... args) Invoice Id.
ProductItem	findProductItem(java.lang.String... args) Product Item.
InvoiceItem	generateCreditItem(MutableDataSource mds, Invoice creditInvoice, double creditAmount) This method is derived from Subscription.
Activity	getActivity(java.lang.String... args)
Invoice	getInvoice()
Invoice	getInvoiceId(java.lang.String... args)
ProductItem	getProductItem(java.lang.String... args)
double	getTotalBuyPriceIncludingTax(java.lang.String... args)
double	getTotalProfit(java.lang.String... args)
double	getUnitBuyPriceIncludingTax(java.lang.String... args)
protected boolean	isModifiableWhenLocked(DBField field)
boolean	requiresPurchase() Does this sale item need a purchase order so that it can be ordered from supplier
InvoiceItem	setActivity(com.aspc.dal.layers.aspc_app.task.Activity value, java.lang.String... args)
protected void	setDontTouchInvoice(boolean fg) To keep the concrete calculated fields the invoice is touched each time a changes is made to an item Some fields will not affect these calculations so for performance reasons we set the dontTouchInvoice flag so that the invoice is not touched meaning it will not be included in the validation and save process
InvoiceItem	setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
InvoiceItem	setProductItem(com.aspc.dal.layers.aspc_app.task.ProductItem value, java.lang.String... args)
InvoiceItem	setUnitBuyPriceIncludingTax(double value, java.lang.String... args)

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

copyIncludeField, extAutoEnterCreate, extCopy, extIsOnChange, 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, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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

An item that appears on an invoice.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

An item that appears on an invoice.

Constructor Detail

InvoiceItem

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

getActivity

@CheckReturnValue
 @Nullable
public Activity getActivity(java.lang.String... args)

findActivity

@CheckReturnValue
 @Nonnull
public final Activity findActivity(java.lang.String... args)
                                                        throws NotFoundException

Activity.

--> Activity (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Activity

Throws:

NotFoundException - Activity was not found

setActivity

@Nonnull
public InvoiceItem setActivity(com.aspc.dal.layers.aspc_app.task.Activity 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, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setInvoiceId

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

Throws:

java.lang.Exception

getProductItem

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

findProductItem

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

Product Item.

--> ProductItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductItem

Throws:

NotFoundException - ProductItem was not found

setProductItem

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

Throws:

java.lang.Exception

getTotalBuyPriceIncludingTax

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

getTotalProfit

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

getUnitBuyPriceIncludingTax

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

setUnitBuyPriceIncludingTax

@Nonnull
public InvoiceItem setUnitBuyPriceIncludingTax(double value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getInvoice

public Invoice getInvoice()

Returns:

the value

requiresPurchase

public boolean requiresPurchase()

Does this sale item need a purchase order so that it can be ordered from supplier

Returns:

the value

generateCreditItem

public InvoiceItem generateCreditItem(MutableDataSource mds,
                                      Invoice creditInvoice,
                                      double creditAmount)
                               throws java.lang.Exception

This method is derived from Subscription. Objective is to generate credit Item

Parameters:

mds - The Mutable DataSource

creditInvoice -

creditAmount -

Returns:

The invoice item

Throws:

java.lang.Exception - A serious error.

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()

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class ChargeItem

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

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

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

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

extDelete

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

Additional functionality when an object is marked for deletion by calling delete().

Overrides:

extDelete in class DBObject

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

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 ChargeItem

Throws:

java.lang.Exception - A serious problem

setDontTouchInvoice

protected void setDontTouchInvoice(boolean fg)

To keep the concrete calculated fields the invoice is touched each time a changes is made to an item Some fields will not affect these calculations so for performance reasons we set the dontTouchInvoice flag so that the invoice is not touched meaning it will not be included in the validation and save process

Parameters:

fg -