com.aspc.Layers.aspc_app.Invoice

Class SettleCredit

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.SettleCredit

All Implemented Interfaces:

SecondaryCacheGroup

public class SettleCredit
extends DBObject

Settles a credit note by allocating the specified amount to an open invoice. A credit note is an invoice that has a negative amount which has been recorded to provide a customer with a credit associated with an invoice (discount, refund or correction to an amount charged) after an invoice has been issued/processed.

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

Since:

31 Jan. 2006

Author:

Michael Zhang

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 Settles a credit note by allocating the specified amount to an open invoice.
static java.lang.String	DBCLASS_NAME Settles a credit note by allocating the specified amount to an open invoice.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SettleCredit	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
Contact	findCustomer(java.lang.String... args) Customer linking to Contact.
Person	findEnteredBy(java.lang.String... args) linking to Person.
static SettleCredit	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.
protected AccountInvSettleCreditSet	generateJournalSet() Generates a new journal set to match current totals for invoice
double	getAmount(java.lang.String... args)
DBObject[]	getBreakDown()
java.util.Date	getCreditDt(java.lang.String... args)
Invoice	getCreditInvoice()
Contact	getCustomer(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnterTime(java.lang.String... args)
double	getFinanceCharge(java.lang.String... args)
int	getID(java.lang.String... args)
DBObject[]	getJournalEntries() Return all journal entries related to this invoice
double	getJournalTotalSettleAmout()
java.lang.String	getMemo(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
double	getRawAmount(java.lang.String... args)
double	getUnallocated(java.lang.String... args)
static DBQuery<SettleCredit>	makeQuery(DataSource ds) Make a new QUERY for this class.
SettleCredit	setAmount(double value, java.lang.String... args)
SettleCredit	setCreditDt(java.util.Date value, java.lang.String... args)
SettleCredit	setCreditInvoice(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
SettleCredit	setCustomer(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
SettleCredit	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
SettleCredit	setEnterTime(java.util.Date value, java.lang.String... args)
SettleCredit	setFinanceCharge(double value, java.lang.String... args)
SettleCredit	setID(int value, java.lang.String... args)
SettleCredit	setMemo(java.lang.String value, java.lang.String... args)
SettleCredit	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
SettleCredit	setRawAmount(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, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, 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

Settles a credit note by allocating the specified amount to an open invoice. A credit note is an invoice that has a negative amount which has been recorded to provide a customer with a credit associated with an invoice (discount, refund or correction to an amount charged) after an invoice has been issued/processed.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Settles a credit note by allocating the specified amount to an open invoice. A credit note is an invoice that has a negative amount which has been recorded to provide a customer with a credit associated with an invoice (discount, refund or correction to an amount charged) after an invoice has been issued/processed.

Constructor Detail

SettleCredit

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

Throws:

java.lang.Exception

getAmount

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

setAmount

@Nonnull
public SettleCredit setAmount(double value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getCreditDt

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

setCreditDt

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

Throws:

java.lang.Exception

setCreditInvoice

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

Throws:

java.lang.Exception

getCustomer

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

findCustomer

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

Customer linking to Contact.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setCustomer

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

Throws:

java.lang.Exception

getEnterTime

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

setEnterTime

@Nonnull
public SettleCredit setEnterTime(java.util.Date 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

linking to Person.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

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

Throws:

java.lang.Exception

getFinanceCharge

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

setFinanceCharge

@Nonnull
public SettleCredit setFinanceCharge(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getMemo

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

setMemo

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

Throws:

java.lang.Exception

getOwnerBusUnit

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

findOwnerBusUnit

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

Business unit that owns this entry.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business Unit

Throws:

NotFoundException - Business was not found

setOwnerBusUnit

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

Throws:

java.lang.Exception

getRawAmount

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

setRawAmount

@Nonnull
public SettleCredit setRawAmount(double value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getUnallocated

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

create

@Nonnull
 @CheckReturnValue
public static SettleCredit create(@Nonnull
                                                              MutableDataSource mds)
                                                       throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

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

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

getCreditInvoice

public Invoice getCreditInvoice()

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

generateJournalSet

protected AccountInvSettleCreditSet generateJournalSet()
                                                throws java.lang.Exception

Generates a new journal set to match current totals for invoice

Throws:

java.lang.Exception

getJournalEntries

public DBObject[] getJournalEntries()

Return all journal entries related to this invoice

getBreakDown

public DBObject[] getBreakDown()

getJournalTotalSettleAmout

public double getJournalTotalSettleAmout()