com.aspc.Layers.aspc_app.Invoice

Class InvoiceProductItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Invoice.InvoiceItem

com.aspc.Layers.aspc_app.Invoice.InvoiceProductItem

All Implemented Interfaces:

SecondaryCacheGroup

public class InvoiceProductItem
extends InvoiceItem

InvoiceProductItem Generic DBObject.

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

Since:

October 22, 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 InvoiceProductItem
static java.lang.String	DBCLASS_NAME InvoiceProductItem

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	adjust()
void	adjustActiveInvoice()
java.util.Date	calcFinalDeliveryDate() Calculates the date of the final delivery
DeliverySchedule	calcFinalDeliverySched() Calculates what the final delivery schedule would be for this sub
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 inParams) update dependent fields.
protected void	extCopy(DBObject target) Additional functionality when an object is copied
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 GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
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 boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreValidate() update dependent fields.
protected void	extUpdateUnitPrice(FldParams params) update unit price
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
NoticeSchedule	findCalcNextNoticeSchedule(java.lang.String... args) Determines the next Notice Schedule that applies to the current state of the item.
InventoryAdjustmentItemType	findInventoryAdjustmentType(java.lang.String... args) Identifies the type of adjustment.
Product	findLabelRunCalcProduct(java.lang.String... args) Label Run Calc Product.
DeliverySchedule	findLastDeliverySchedule(java.lang.String... args) Holds a link to the last delivery schedule if deliveries are made via a schedule.
TaskNoticeNote	findNextDeliveryNotice(java.lang.String... args) The notice that should be sent out with the next delivery.
NoticeSchedule	findNextNoticeSchedule(java.lang.String... args) Next Notice Schedule.
Contact	findOrderSupplier(java.lang.String... args) Supplier to order item from.
Product	findProduct(java.lang.String... args) Product.
PriceMatrix	findRenewalPriceMatrix(java.lang.String... args) Determines the Price Matrix object that will be used to determine price for a renewal of this Product item.
StockBinItem	findStockBinItem(java.lang.String... args) If product is inventoried then the Stock Item identifies the location that it is monitored.
InvoiceItem	generateCreditItem(MutableDataSource mds, Invoice creditInvoice, double creditAmount) This method is derived from Subscription.
GeneralTask	generatePickup(java.util.Date pickupDt) returns the General Task
int	getAdjNumDeliveries(java.lang.String... args)
double	getBackorder(java.lang.String... args)
NoticeSchedule	getCalcNextNoticeSchedule(java.lang.String... args)
int	getCalcNumDeliveries(java.lang.String... args)
java.util.Date	getDeliveredDate(java.lang.String... args)
double	getDeliveriesMade(java.lang.String... args)
int	getDeliveriesMadeAdd(java.lang.String... args)
double	getDeliveriesRemaining(java.lang.String... args)
java.lang.String	getEvalPeriod(java.lang.String... args)
InventoryAdjustmentItemType	getInventoryAdjustmentType(java.lang.String... args)
double	getInventoryAmountAdjusted(java.lang.String... args)
double	getInventoryCostOfSale(java.lang.String... args)
double	getInventoryQtyAdjusted(java.lang.String... args)
double	getInventoryQtyCommitted(java.lang.String... args)
int	getItemsDelivered(java.lang.String... args)
double	getItemsRemaining(java.lang.String... args)
Product	getLabelRunCalcProduct(java.lang.String... args)
java.util.Date	getLastDelivered(java.lang.String... args)
DeliverySchedule	getLastDeliverySchedule(java.lang.String... args)
TaskNoticeNote	getNextDeliveryNotice(java.lang.String... args)
NoticeSchedule	getNextNoticeSchedule(java.lang.String... args)
Contact	getOrderSupplier(java.lang.String... args)
int	getOrigNumDeliveries(java.lang.String... args)
Product	getProduct(java.lang.String... args)
double	getReceived(java.lang.String... args)
PriceMatrix	getRenewalPriceMatrix(java.lang.String... args)
StockBinItem	getStockBinItem(java.lang.String... args)
boolean	hasDeliverySched(java.lang.String... args)
boolean	hasIssueAlloc(java.lang.String... args)
boolean	isDefaultProductCostRequired(java.lang.String... args)
boolean	isIncludeInLabelRun(java.lang.String... args)
boolean	isLabelRunIsDelivered(java.lang.String... args)
boolean	isLabelRunIsPartOfSchedule(java.lang.String... args)
protected boolean	isModifiableWhenLocked(DBField field)
boolean	isOrderFromSupplier(java.lang.String... args)
boolean	isPickup(java.lang.String... args)
boolean	isProductChangedAfterPayment(java.lang.String... args)
ProductPartBreakDown	recordDelivery(java.util.Date sendDate)
ProductPartBreakDown	recordDelivery(java.util.Date sendDate, int numDeliveries) Records a delivery for a specific date This is used if we are not delivering an item based on a delivery schedule
ProductPartBreakDown	recordDelivery(DeliverySchedule sched, java.util.Date sendDate)
ProductPartBreakDown	recordDelivery(DeliverySchedule sched, java.util.Date sendDate, int numDeliveries)
TaskNoticeNote	recordNotice(NoticeSchedule ns)
GeneralTask	recordNoticeTask(TaskNoticeNote tn)
boolean	requiresPurchase() requires purchase
NoticeSchedule	scheduleNotice() schedule the notice
InvoiceProductItem	setAdjNumDeliveries(int value, java.lang.String... args)
InvoiceProductItem	setBackorder(double value, java.lang.String... args)
InvoiceProductItem	setCalcNumDeliveries(int value, java.lang.String... args)
InvoiceProductItem	setDefaultProductCostRequired(boolean value, java.lang.String... args)
InvoiceProductItem	setDeliveredDate(java.util.Date value, java.lang.String... args)
InvoiceProductItem	setDeliveriesMade(double value, java.lang.String... args)
InvoiceProductItem	setDeliveriesMadeAdd(int value, java.lang.String... args)
InvoiceProductItem	setDeliveriesRemaining(double value, java.lang.String... args)
InvoiceProductItem	setEvalPeriod(java.lang.String value, java.lang.String... args)
InvoiceProductItem	setInventoryCostOfSale(double value, java.lang.String... args)
InvoiceProductItem	setLastDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule value, java.lang.String... args)
InvoiceProductItem	setNextNoticeSchedule(com.aspc.dal.layers.aspc_app.notices.NoticeSchedule value, java.lang.String... args)
InvoiceProductItem	setOrderFromSupplier(boolean value, java.lang.String... args)
InvoiceProductItem	setOrderSupplier(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
InvoiceProductItem	setOrigNumDeliveries(int value, java.lang.String... args)
InvoiceProductItem	setPickup(boolean value, java.lang.String... args)
InvoiceProductItem	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
InvoiceProductItem	setProductChangedAfterPayment(boolean value, java.lang.String... args)
InvoiceProductItem	setReceived(double value, java.lang.String... args)
InvoiceProductItem	setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value, java.lang.String... args)
void	updateDeliveriesMade() update the deliveries made
protected void	updateDeliveriesRemaining() update the remaining deliveries
void	updateLastDeliverySchedule() Update the lastDeliverySchedule field to be linked to schedule associated with the last delivery
void	updateNumDeliveries(FldParams params) Update numDeliveries which is determined by looking up the SubscriptionIssuesAlloc table based on term, type and product
protected void	updateTotalDeliveries() update the total deliveries
void	updateUnitPrice(FldParams params) update the unit price

Methods inherited from class com.aspc.Layers.aspc_app.Invoice.InvoiceItem

extCheckModifyAccess, extCheckReadAccess, findActivity, findInvoiceId, findProductItem, getActivity, getInvoice, getInvoiceId, getProductItem, getTotalBuyPriceIncludingTax, getTotalProfit, getUnitBuyPriceIncludingTax, setActivity, setDontTouchInvoice, setInvoiceId, setProductItem, setUnitBuyPriceIncludingTax

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

InvoiceProductItem

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

InvoiceProductItem

Constructor Detail

InvoiceProductItem

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

getAdjNumDeliveries

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

setAdjNumDeliveries

@Nonnull
public InvoiceProductItem setAdjNumDeliveries(int value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getBackorder

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

setBackorder

@Nonnull
public InvoiceProductItem setBackorder(double value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getCalcNextNoticeSchedule

@CheckReturnValue
 @Nullable
public NoticeSchedule getCalcNextNoticeSchedule(java.lang.String... args)

findCalcNextNoticeSchedule

@CheckReturnValue
 @Nonnull
public final NoticeSchedule findCalcNextNoticeSchedule(java.lang.String... args)
                                                                            throws NotFoundException

Determines the next Notice Schedule that applies to the current state of the item.

--> NoticeSchedule (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

NoticeSchedule

Throws:

NotFoundException - NoticeSchedule was not found

getCalcNumDeliveries

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

setCalcNumDeliveries

@Nonnull
public InvoiceProductItem setCalcNumDeliveries(int value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

isDefaultProductCostRequired

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

setDefaultProductCostRequired

@Nonnull
public InvoiceProductItem setDefaultProductCostRequired(boolean value,
                                                                 java.lang.String... args)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveredDate

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

setDeliveredDate

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

Throws:

java.lang.Exception

getDeliveriesMade

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

setDeliveriesMade

@Nonnull
public InvoiceProductItem setDeliveriesMade(double value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveriesMadeAdd

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

setDeliveriesMadeAdd

@Nonnull
public InvoiceProductItem setDeliveriesMadeAdd(int value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveriesRemaining

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

setDeliveriesRemaining

@Nonnull
public InvoiceProductItem setDeliveriesRemaining(double value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getEvalPeriod

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

setEvalPeriod

@Nonnull
public InvoiceProductItem setEvalPeriod(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

hasDeliverySched

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

hasIssueAlloc

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

isIncludeInLabelRun

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

getInventoryAdjustmentType

@CheckReturnValue
 @Nullable
public InventoryAdjustmentItemType getInventoryAdjustmentType(java.lang.String... args)

findInventoryAdjustmentType

@CheckReturnValue
 @Nonnull
public final InventoryAdjustmentItemType findInventoryAdjustmentType(java.lang.String... args)
                                                                                          throws NotFoundException

Identifies the type of adjustment.

--> .InventoryAdjustmentItemType InventoryAdjustmentItemType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

InventoryAdjustmentItemType

Throws:

NotFoundException - InventoryAdjustmentItemType was not found

getInventoryAmountAdjusted

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

getInventoryCostOfSale

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

setInventoryCostOfSale

@Nonnull
public InvoiceProductItem setInventoryCostOfSale(double value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getInventoryQtyAdjusted

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

getInventoryQtyCommitted

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

isProductChangedAfterPayment

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

setProductChangedAfterPayment

@Nonnull
public InvoiceProductItem setProductChangedAfterPayment(boolean value,
                                                                 java.lang.String... args)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getItemsDelivered

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

getItemsRemaining

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

getLabelRunCalcProduct

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

findLabelRunCalcProduct

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

Label Run Calc Product.

--> Product (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

isLabelRunIsDelivered

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

isLabelRunIsPartOfSchedule

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

getLastDelivered

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

getLastDeliverySchedule

@CheckReturnValue
 @Nullable
public DeliverySchedule getLastDeliverySchedule(java.lang.String... args)

findLastDeliverySchedule

@CheckReturnValue
 @Nonnull
public final DeliverySchedule findLastDeliverySchedule(java.lang.String... args)
                                                                            throws NotFoundException

Holds a link to the last delivery schedule if deliveries are made via a schedule.
A delivery record will be generated if one does not already exist when this field changes.

--> DeliverySchedule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliverySchedule

Throws:

NotFoundException - DeliverySchedule was not found

setLastDeliverySchedule

@Nonnull
public InvoiceProductItem setLastDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getNextDeliveryNotice

@CheckReturnValue
 @Nullable
public TaskNoticeNote getNextDeliveryNotice(java.lang.String... args)

findNextDeliveryNotice

@CheckReturnValue
 @Nonnull
public final TaskNoticeNote findNextDeliveryNotice(java.lang.String... args)
                                                                        throws NotFoundException

The notice that should be sent out with the next delivery.

--> TaskNoticeNote (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskNoticeNote

Throws:

NotFoundException - TaskNoticeNote was not found

getNextNoticeSchedule

@CheckReturnValue
 @Nullable
public NoticeSchedule getNextNoticeSchedule(java.lang.String... args)

findNextNoticeSchedule

@CheckReturnValue
 @Nonnull
public final NoticeSchedule findNextNoticeSchedule(java.lang.String... args)
                                                                        throws NotFoundException

Next Notice Schedule.

--> NoticeSchedule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

NoticeSchedule

Throws:

NotFoundException - NoticeSchedule was not found

setNextNoticeSchedule

@Nonnull
public InvoiceProductItem setNextNoticeSchedule(com.aspc.dal.layers.aspc_app.notices.NoticeSchedule value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

isOrderFromSupplier

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

setOrderFromSupplier

@Nonnull
public InvoiceProductItem setOrderFromSupplier(boolean value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getOrderSupplier

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

findOrderSupplier

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

Supplier to order item from.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setOrderSupplier

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

Throws:

java.lang.Exception

getOrigNumDeliveries

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

setOrigNumDeliveries

@Nonnull
public InvoiceProductItem setOrigNumDeliveries(int value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

isPickup

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

setPickup

@Nonnull
public InvoiceProductItem setPickup(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getProduct

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

findProduct

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

Product.

--> Product (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

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

Throws:

java.lang.Exception

getReceived

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

setReceived

@Nonnull
public InvoiceProductItem setReceived(double value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getRenewalPriceMatrix

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

findRenewalPriceMatrix

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

Determines the Price Matrix object that will be used to determine price for a renewal of this Product item.

--> PriceMatrix (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrix

Throws:

NotFoundException - PriceMatrix was not found

getStockBinItem

@CheckReturnValue
 @Nullable
public StockBinItem getStockBinItem(java.lang.String... args)

findStockBinItem

@CheckReturnValue
 @Nonnull
public final StockBinItem findStockBinItem(java.lang.String... args)
                                                                throws NotFoundException

If product is inventoried then the Stock Item identifies the location that it is monitored.

--> StockBinItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

StockBinItem

Throws:

NotFoundException - StockBinItem was not found

setStockBinItem

@Nonnull
public InvoiceProductItem setStockBinItem(com.aspc.dal.layers.aspc_app.inventory.StockBinItem value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

updateDeliveriesMade

public void updateDeliveriesMade()
                          throws java.lang.Exception

update the deliveries made

Throws:

java.lang.Exception - a serious problem

updateTotalDeliveries

protected void updateTotalDeliveries()
                              throws java.lang.Exception

update the total deliveries

Throws:

java.lang.Exception - a serious problem

adjustActiveInvoice

public void adjustActiveInvoice()
                         throws java.lang.Exception

Throws:

java.lang.Exception

updateDeliveriesRemaining

protected void updateDeliveriesRemaining()
                                  throws java.lang.Exception

update the remaining deliveries

Throws:

java.lang.Exception - a serious problem

calcFinalDeliveryDate

public java.util.Date calcFinalDeliveryDate()
                                     throws java.lang.Exception

Calculates the date of the final delivery

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calcFinalDeliverySched

public DeliverySchedule calcFinalDeliverySched()
                                        throws java.lang.Exception

Calculates what the final delivery schedule would be for this sub

Returns:

the value

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 InvoiceItem

Throws:

java.lang.Exception - A serious problem

updateLastDeliverySchedule

public void updateLastDeliverySchedule()
                                throws java.lang.Exception

Update the lastDeliverySchedule field to be linked to schedule associated with the last delivery

Throws:

java.lang.Exception - a serious problem

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 ChargeItem

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.

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 ChargeItem

Parameters:

field - is DBField

Returns:

Boolean value

requiresPurchase

public boolean requiresPurchase()

requires purchase

Overrides:

requiresPurchase in class InvoiceItem

Returns:

boolean value for the field orderFromSupplier

generatePickup

public GeneralTask generatePickup(java.util.Date pickupDt)
                           throws java.lang.Exception

returns the General Task

Parameters:

pickupDt - is a date

Returns:

Generaltask object

Throws:

java.lang.Exception - a serious problem

scheduleNotice

public NoticeSchedule scheduleNotice()
                              throws java.lang.Exception

schedule the notice

Returns:

NoticeSchedule object

Throws:

java.lang.Exception - a serious problem

recordNotice

@Nonnull
public TaskNoticeNote recordNotice(@Nonnull
                                            NoticeSchedule ns)
                                     throws java.lang.Exception

Parameters:

ns -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

recordNoticeTask

@Nullable
public GeneralTask recordNoticeTask(@Nullable
                                              TaskNoticeNote tn)
                                       throws java.lang.Exception

Parameters:

tn -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

recordDelivery

public ProductPartBreakDown recordDelivery(java.util.Date sendDate)
                                    throws java.lang.Exception

Parameters:

sendDate -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

recordDelivery

public ProductPartBreakDown recordDelivery(java.util.Date sendDate,
                                           int numDeliveries)
                                    throws java.lang.Exception

Records a delivery for a specific date This is used if we are not delivering an item based on a delivery schedule

Parameters:

sendDate -

numDeliveries -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

recordDelivery

public ProductPartBreakDown recordDelivery(DeliverySchedule sched,
                                           java.util.Date sendDate)
                                    throws java.lang.Exception

Parameters:

sched -

sendDate -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

recordDelivery

public ProductPartBreakDown recordDelivery(DeliverySchedule sched,
                                           java.util.Date sendDate,
                                           int numDeliveries)
                                    throws java.lang.Exception

Parameters:

sched -

sendDate -

numDeliveries -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

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

Overrides:

generateCreditItem in class InvoiceItem

Parameters:

creditInvoice - The Source Invoice Product Item

mds - The Mutable DataSource

creditAmount -

Returns:

Throws:

java.lang.Exception - A serious error.

isModifiableWhenLocked

protected boolean isModifiableWhenLocked(DBField field)

Overrides:

isModifiableWhenLocked in class InvoiceItem

Parameters:

field - The field

Returns:

the value

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams inParams)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class InvoiceItem

Parameters:

inParams -

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

Throws:

java.lang.Exception - a serious problem

extPreValidate

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

update dependent fields.

Overrides:

extPreValidate in class ChargeItem

Throws:

java.lang.Exception - a serious problem

adjust

public void adjust()
            throws java.lang.Exception

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 this field.

Overrides:

extGetDerivedValue in class InvoiceItem

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

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated global key

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 InvoiceItem

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extValidateRecord

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

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

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

updateNumDeliveries

public final void updateNumDeliveries(FldParams params)
                               throws java.lang.Exception

Update numDeliveries which is determined by looking up the SubscriptionIssuesAlloc table based on term, type and product

Parameters:

params - is a field params

Throws:

java.lang.Exception - a serious problem

updateUnitPrice

public final void updateUnitPrice(FldParams params)
                           throws java.lang.Exception

update the unit price

Parameters:

params - is a field params

Throws:

java.lang.Exception - a serious problem

extUpdateUnitPrice

protected void extUpdateUnitPrice(FldParams params)
                           throws java.lang.Exception

update unit price

Parameters:

params - is a field params

Throws:

java.lang.Exception - a serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class InvoiceItem

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extCopy

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

Additional functionality when an object is copied

Overrides:

extCopy in class ChargeItem

Parameters:

target - The target object

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 InvoiceItem

Throws:

java.lang.Exception - A serious problem