com.aspc.Layers.aspc_app.Invoice

Class InvoiceRefund

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.InvoiceRefund

All Implemented Interfaces:

SecondaryCacheGroup

public class InvoiceRefund
extends DBObject

Payment
Records a refund to the customer from a credit note.

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

Since:

14 February 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 Records a refund to the customer from a credit note.
static java.lang.String	DBCLASS_NAME Records a refund to the customer from a credit note.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static InvoiceRefund	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	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Account	findAccount(java.lang.String... args) a mandatory field which links to Account.
Contact	findCustomer(java.lang.String... args) link to Contact.
Person	findEnterBy(java.lang.String... args) link to person.
static InvoiceRefund	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 AccountInvoiceRefundSet	generateJournalSet() Generates a new journal set to match current totals for invoice
Account	getAccount(java.lang.String... args)
java.lang.String	getBankAccountName(java.lang.String... args)
java.lang.String	getBankAccountNum(java.lang.String... args)
java.lang.String	getBankBSB(java.lang.String... args)
DBObject[]	getBreakDown()
Contact	getCustomer(java.lang.String... args)
Person	getEnterBy(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	getJournalTotalRefund()
java.lang.String	getMemo(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
double	getRefundAmount(java.lang.String... args)
java.util.Date	getRefundDate(java.lang.String... args)
double	getUnallocated(java.lang.String... args)
static DBQuery<InvoiceRefund>	makeQuery(DataSource ds) Make a new QUERY for this class.
InvoiceRefund	setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value, java.lang.String... args)
InvoiceRefund	setBankAccountName(java.lang.String value, java.lang.String... args)
InvoiceRefund	setBankAccountNum(java.lang.String value, java.lang.String... args)
InvoiceRefund	setBankBSB(java.lang.String value, java.lang.String... args)
InvoiceRefund	setCustomer(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
InvoiceRefund	setEnterBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
InvoiceRefund	setEnterTime(java.util.Date value, java.lang.String... args)
InvoiceRefund	setFinanceCharge(double value, java.lang.String... args)
InvoiceRefund	setID(int value, java.lang.String... args)
InvoiceRefund	setMemo(java.lang.String value, java.lang.String... args)
InvoiceRefund	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
InvoiceRefund	setRefundAmount(double value, java.lang.String... args)
InvoiceRefund	setRefundDate(java.util.Date value, java.lang.String... args)
InvoiceRefund	setUnallocated(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, 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, 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

Records a refund to the customer from a credit note.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Records a refund to the customer from a credit note.

Constructor Detail

InvoiceRefund

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

a mandatory field which links to Account.

--> Account (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Account

Throws:

NotFoundException - Account was not found

setAccount

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

Throws:

java.lang.Exception

getBankAccountName

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

setBankAccountName

@Nonnull
public InvoiceRefund setBankAccountName(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getBankAccountNum

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

setBankAccountNum

@Nonnull
public InvoiceRefund setBankAccountNum(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getBankBSB

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

setBankBSB

@Nonnull
public InvoiceRefund setBankBSB(java.lang.String 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

link to Contact.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setCustomer

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

Throws:

java.lang.Exception

getEnterBy

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

findEnterBy

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

link to person.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnterBy

@Nonnull
public InvoiceRefund setEnterBy(com.aspc.dal.layers.aspc_app.contact.Person 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 InvoiceRefund setEnterTime(java.util.Date 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 InvoiceRefund 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 InvoiceRefund 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 InvoiceRefund setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRefundAmount

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

setRefundAmount

@Nonnull
public InvoiceRefund setRefundAmount(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRefundDate

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

setRefundDate

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

Throws:

java.lang.Exception

getUnallocated

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

setUnallocated

@Nonnull
public InvoiceRefund setUnallocated(double value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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

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 AccountInvoiceRefundSet generateJournalSet()
                                              throws java.lang.Exception

Generates a new journal set to match current totals for invoice

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getJournalEntries

public DBObject[] getJournalEntries()

Return all journal entries related to this invoice

Returns:

the value

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

getBreakDown

public DBObject[] getBreakDown()

Returns:

the value

getJournalTotalRefund

public double getJournalTotalRefund()
                             throws NotFoundException

Returns:

the value

Throws:

NotFoundException