com.aspc.Layers.aspc_app.Task

Class ChargeItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ExpenseItem, InvoiceItem, JobItem, PurchaseItem, RoyaltyItem, StockBinAdjustmentItem, SupplierQuoteItem

public class ChargeItem
extends DBObject

ChargeItem represents a chargeable line item It is responsible for calculating the correct figures in accordance with accounting rules. The total amount including tax is the total amount after discount is applied and should always be in terms of money, ie rounded to 2 decimal places. No other figures, such as tax can be rounded on each line item as this is done after adding all line items. The total excluding tax for all line itme swill always be the total including tax less the total tax amount. Since the total tax amount is rounded at the end, the total excluding tax may be one cent different from the sum of 'total excluding tax' amounts of each line item
Generic DBObject.

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

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	copyIncludeField(DBObject orig, DBField field) Excludes some fields from copy as they need to be recalculated
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	extCopy(DBObject target) Additional functionality when an object is copied
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) OVERRIDE This method to specify fields should be mandatory under certain contions.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
Account	findAccount(java.lang.String... args) Ledger account number this item is to be applied to.
Person	findAdjPriceCheckedBy(java.lang.String... args) Person that checked the adjustment.
ChargeItemPriceAdjReason	findAdjPriceReason(java.lang.String... args) The reason that the adjustment was made.
PriceMatrix	findCalcPriceMatrix(java.lang.String... args) Calculates the price matrix that should be used.
java.lang.Object	findChargeItemStatus(java.lang.String... args) charge Item Status.
java.lang.Object	findChargeItemType(java.lang.String... args) Charge Item Type.
Person	findEnteredBy(java.lang.String... args) The person that created the charge item.
DBTriStateOption	findExportFg(java.lang.String... args) Indicates that the item is to be exported.
static ChargeItem	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.
ChargeItem	findRecurringBase(java.lang.String... args) Recurring Base.
TaxCode	findTaxCodeId(java.lang.String... args) Select tax code from drop down list.
Account	getAccount(java.lang.String... args)
Person	getAdjPriceCheckedBy(java.lang.String... args)
java.lang.String	getAdjPriceCheckedNotes(java.lang.String... args)
ChargeItemPriceAdjReason	getAdjPriceReason(java.lang.String... args)
java.lang.String	getAdjPriceReasonNotes(java.lang.String... args)
double	getAdjTotalPrice(java.lang.String... args)
double	getAdjTotalPriceIncludingTax(java.lang.String... args)
double	getAdjUnitPrice(java.lang.String... args)
double	getAdjUnitPriceExcludingTax(java.lang.String... args)
double	getAdjUnitPriceIncludingTax(java.lang.String... args)
double	getBackOrdered(java.lang.String... args)
PriceMatrix	getCalcPriceMatrix(java.lang.String... args)
double	getCalcUnitPriceExcludingTax(java.lang.String... args)
java.lang.Object	getChargeItemStatus(java.lang.String... args)
java.lang.Object	getChargeItemType(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
double	getDiscountRate(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)
int	getID(java.lang.String... args)
java.lang.String	getItemCode(java.lang.String... args)
java.util.Date	getMyobImportTime(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
double	getOrdered(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
double	getQty(java.lang.String... args)
ChargeItem	getRecurringBase(java.lang.String... args)
DBObject[]	getRoyalties()
TaxCode	getTaxCodeId(java.lang.String... args)
double	getTaxRate(java.lang.String... args)
double	getTotalDiscount(java.lang.String... args)
double	getTotalPriceExcludingTax(java.lang.String... args)
double	getTotalPriceIncludingTax(java.lang.String... args)
double	getTotalRoyalties(java.lang.String... args)
double	getTotalTax(java.lang.String... args)
java.lang.String	getUnitMeasure(java.lang.String... args)
double	getUnitPrice(java.lang.String... args)
double	getUnitPriceDisplay(java.lang.String... args)
double	getUnitPriceDisplayExcludingTax(java.lang.String... args)
double	getUnitPriceDisplayIncludingTax(java.lang.String... args)
double	getUnitPriceExcludingTax(java.lang.String... args)
double	getUnitPriceIncludingTax(java.lang.String... args)
boolean	hasReadAccess(java.lang.String... args)
boolean	isAdjPriceChecked(java.lang.String... args)
boolean	isAdjPriceReasonRequired(java.lang.String... args)
boolean	isAdjTotalPriceIncludesTax(java.lang.String... args)
boolean	isAdjUnitPriceIncludesTax(java.lang.String... args)
boolean	isAdjustItem(java.lang.String... args)
boolean	isMonthlyRecurring(java.lang.String... args)
boolean	isNeedToBeCloned(java.lang.String... args)
boolean	isUnitPriceIncludesTax(java.lang.String... args)
static DBQuery<ChargeItem>	makeQuery(DataSource ds) Make a new QUERY for this class.
ChargeItem	setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value, java.lang.String... args)
ChargeItem	setAdjPriceChecked(boolean value, java.lang.String... args)
ChargeItem	setAdjPriceCheckedBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
ChargeItem	setAdjPriceCheckedNotes(java.lang.String value, java.lang.String... args)
ChargeItem	setAdjPriceReason(com.aspc.dal.layers.aspc_app.task.ChargeItemPriceAdjReason value, java.lang.String... args)
ChargeItem	setAdjPriceReasonNotes(java.lang.String value, java.lang.String... args)
ChargeItem	setAdjPriceReasonRequired(boolean value, java.lang.String... args)
ChargeItem	setAdjTotalPrice(double value, java.lang.String... args)
ChargeItem	setAdjTotalPriceIncludesTax(boolean value, java.lang.String... args)
ChargeItem	setAdjTotalPriceIncludingTax(double value, java.lang.String... args)
ChargeItem	setAdjUnitPrice(double value, java.lang.String... args)
ChargeItem	setAdjUnitPriceIncludesTax(boolean value, java.lang.String... args)
ChargeItem	setAdjustItem(boolean value, java.lang.String... args)
ChargeItem	setBackOrdered(double value, java.lang.String... args)
ChargeItem	setChargeItemStatus(java.lang.Object value, java.lang.String... args)
ChargeItem	setCode(java.lang.String value, java.lang.String... args)
ChargeItem	setDescription(java.lang.String value, java.lang.String... args)
ChargeItem	setDiscountRate(double value, java.lang.String... args)
ChargeItem	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
ChargeItem	setEnteredTime(java.util.Date value, java.lang.String... args)
ChargeItem	setExportedTime(java.util.Date value, java.lang.String... args)
ChargeItem	setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
ChargeItem	setID(int value, java.lang.String... args)
ChargeItem	setItemCode(java.lang.String value, java.lang.String... args)
ChargeItem	setMonthlyRecurring(boolean value, java.lang.String... args)
ChargeItem	setMyobImportTime(java.util.Date value, java.lang.String... args)
ChargeItem	setNotes(java.lang.String value, java.lang.String... args)
ChargeItem	setOrdered(double value, java.lang.String... args)
ChargeItem	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
ChargeItem	setQty(double value, java.lang.String... args)
ChargeItem	setRecurringBase(com.aspc.dal.layers.aspc_app.task.ChargeItem value, java.lang.String... args)
ChargeItem	setTaxCodeId(com.aspc.dal.layers.aspc_app.misc.Tax value, java.lang.String... args)
ChargeItem	setTaxRate(double value, java.lang.String... args)
ChargeItem	setUnitMeasure(java.lang.String value, java.lang.String... args)
ChargeItem	setUnitPrice(double value, java.lang.String... args)
ChargeItem	setUnitPriceExcludingTax(double value, java.lang.String... args)
ChargeItem	setUnitPriceIncludesTax(boolean value, java.lang.String... args)
ChargeItem	setUnitPriceIncludingTax(double value, java.lang.String... args)

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, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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

ChargeItem

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ChargeItem

Constructor Detail

ChargeItem

public ChargeItem(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 ChargeItem setID(int value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getAccount

@CheckReturnValue
 @Nullable
public Account getAccount(java.lang.String... args)

findAccount

@CheckReturnValue
 @Nonnull
public final Account findAccount(java.lang.String... args)
                                                      throws NotFoundException

Ledger account number this item is to be applied to.

--> Account (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Account

Throws:

NotFoundException - Account was not found

setAccount

@Nonnull
public ChargeItem setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isAdjPriceChecked

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

setAdjPriceChecked

@Nonnull
public ChargeItem setAdjPriceChecked(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getAdjPriceCheckedBy

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

findAdjPriceCheckedBy

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

Person that checked the adjustment.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setAdjPriceCheckedBy

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

Throws:

java.lang.Exception

getAdjPriceCheckedNotes

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

setAdjPriceCheckedNotes

@Nonnull
public ChargeItem setAdjPriceCheckedNotes(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getAdjPriceReason

@CheckReturnValue
 @Nullable
public ChargeItemPriceAdjReason getAdjPriceReason(java.lang.String... args)

findAdjPriceReason

@CheckReturnValue
 @Nonnull
public final ChargeItemPriceAdjReason findAdjPriceReason(java.lang.String... args)
                                                                              throws NotFoundException

The reason that the adjustment was made.

--> ChargeItemPriceAdjReason (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ChargeItemPriceAdjReason

Throws:

NotFoundException - ChargeItemPriceAdjReason was not found

setAdjPriceReason

@Nonnull
public ChargeItem setAdjPriceReason(com.aspc.dal.layers.aspc_app.task.ChargeItemPriceAdjReason value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getAdjPriceReasonNotes

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

setAdjPriceReasonNotes

@Nonnull
public ChargeItem setAdjPriceReasonNotes(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isAdjPriceReasonRequired

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

setAdjPriceReasonRequired

@Nonnull
public ChargeItem setAdjPriceReasonRequired(boolean value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getAdjTotalPrice

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

setAdjTotalPrice

@Nonnull
public ChargeItem setAdjTotalPrice(double value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isAdjTotalPriceIncludesTax

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

setAdjTotalPriceIncludesTax

@Nonnull
public ChargeItem setAdjTotalPriceIncludesTax(boolean value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getAdjTotalPriceIncludingTax

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

setAdjTotalPriceIncludingTax

@Nonnull
public ChargeItem setAdjTotalPriceIncludingTax(double value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getAdjUnitPrice

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

setAdjUnitPrice

@Nonnull
public ChargeItem setAdjUnitPrice(double value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAdjUnitPriceExcludingTax

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

isAdjUnitPriceIncludesTax

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

setAdjUnitPriceIncludesTax

@Nonnull
public ChargeItem setAdjUnitPriceIncludesTax(boolean value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAdjUnitPriceIncludingTax

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

isAdjustItem

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

setAdjustItem

@Nonnull
public ChargeItem setAdjustItem(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getBackOrdered

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

setBackOrdered

@Nonnull
public ChargeItem setBackOrdered(double value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getCalcPriceMatrix

@CheckReturnValue
 @Nullable
public PriceMatrix getCalcPriceMatrix(java.lang.String... args)

findCalcPriceMatrix

@CheckReturnValue
 @Nonnull
public final PriceMatrix findCalcPriceMatrix(java.lang.String... args)
                                                                  throws NotFoundException

Calculates the price matrix that should be used.

--> PriceMatrix (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrix

Throws:

NotFoundException - PriceMatrix was not found

getCalcUnitPriceExcludingTax

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

getChargeItemStatus

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

findChargeItemStatus

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

charge Item Status.

--> ChargeItemStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ChargeItemStatus

Throws:

NotFoundException - ChargeItemStatus was not found

setChargeItemStatus

@Nonnull
public ChargeItem setChargeItemStatus(java.lang.Object value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getChargeItemType

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

findChargeItemType

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

Charge Item Type.

--> ChargeItemType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

ChargeItemType

Throws:

NotFoundException - ChargeItemType was not found

getCode

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

setCode

@Nonnull
public ChargeItem setCode(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 ChargeItem setDescription(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDiscountRate

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

setDiscountRate

@Nonnull
public ChargeItem setDiscountRate(double 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

The person that created the charge item.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

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

Throws:

java.lang.Exception

getEnteredTime

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

setEnteredTime

@Nonnull
public ChargeItem 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 that the item is to be exported.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setExportFg

@Nonnull
public ChargeItem 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 ChargeItem setExportedTime(java.util.Date value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

hasReadAccess

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

getItemCode

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

setItemCode

@Nonnull
public ChargeItem setItemCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isMonthlyRecurring

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

setMonthlyRecurring

@Nonnull
public ChargeItem setMonthlyRecurring(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getMyobImportTime

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

setMyobImportTime

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

Throws:

java.lang.Exception

isNeedToBeCloned

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

getNotes

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

setNotes

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

Throws:

java.lang.Exception

getOrdered

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

setOrdered

@Nonnull
public ChargeItem setOrdered(double 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 ChargeItem setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getQty

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

setQty

@Nonnull
public ChargeItem setQty(double value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getRecurringBase

@CheckReturnValue
 @Nullable
public ChargeItem getRecurringBase(java.lang.String... args)

findRecurringBase

@CheckReturnValue
 @Nonnull
public final ChargeItem findRecurringBase(java.lang.String... args)
                                                               throws NotFoundException

Recurring Base.

--> ChargeItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

ChargeItem

Throws:

NotFoundException - ChargeItem was not found

setRecurringBase

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

Throws:

java.lang.Exception

getTaxCodeId

@CheckReturnValue
 @Nullable
public TaxCode getTaxCodeId(java.lang.String... args)

findTaxCodeId

@CheckReturnValue
 @Nonnull
public final TaxCode findTaxCodeId(java.lang.String... args)
                                                        throws NotFoundException

Select tax code from drop down list.

--> Tax (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Tax Codes

Throws:

NotFoundException - Tax was not found

setTaxCodeId

@Nonnull
public ChargeItem setTaxCodeId(com.aspc.dal.layers.aspc_app.misc.Tax value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getTaxRate

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

setTaxRate

@Nonnull
public ChargeItem setTaxRate(double value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getTotalDiscount

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

getTotalPriceExcludingTax

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

getTotalPriceIncludingTax

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

getTotalRoyalties

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

getTotalTax

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

getUnitMeasure

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

setUnitMeasure

@Nonnull
public ChargeItem setUnitMeasure(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getUnitPrice

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

setUnitPrice

@Nonnull
public ChargeItem setUnitPrice(double value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getUnitPriceDisplay

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

getUnitPriceDisplayExcludingTax

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

getUnitPriceDisplayIncludingTax

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

getUnitPriceExcludingTax

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

setUnitPriceExcludingTax

@Nonnull
public ChargeItem setUnitPriceExcludingTax(double value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

isUnitPriceIncludesTax

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

setUnitPriceIncludesTax

@Nonnull
public ChargeItem setUnitPriceIncludesTax(boolean value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getUnitPriceIncludingTax

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

setUnitPriceIncludingTax

@Nonnull
public ChargeItem setUnitPriceIncludingTax(double value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

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

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

OVERRIDE This method to specify fields should be mandatory under certain contions.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

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

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

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

Overrides:

extIsOnChange in class DBObject

Parameters:

field - The field

Returns:

the value

copyIncludeField

@CheckReturnValue
public boolean copyIncludeField(@Nonnull
                                                  DBObject orig,
                                                  @Nonnull
                                                  DBField field)
                                           throws java.lang.Exception

Excludes some fields from copy as they need to be recalculated

Overrides:

copyIncludeField in class DBObject

Parameters:

orig - The original object to be copied.

field - The field to be copied

Returns:

false if the field is not allowed to copy.

Throws:

java.lang.Exception - A serious error.

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

getRoyalties

public DBObject[] getRoyalties()

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

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

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

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied

Overrides:

extCopy in class DBObject

Parameters:

target - The target object

Throws:

java.lang.Exception - A serious problem