com.aspc.Layers.aspc_app.Invoice

Class InvoicePaymentBreakDown

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.InvoicePaymentBreakDown

All Implemented Interfaces:

SecondaryCacheGroup

public class InvoicePaymentBreakDown
extends DBObject

Payment
Generic DBObject.

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

Since:

28 September 2001

Author:

Nigel Leck

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

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static InvoicePaymentBreakDown	create(MutableDataSource mds) Make a new instance of this class.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extCheckReadAccess() Additional access checking for READ access of this object.
protected void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
DBTriStateOption	findExportFg(java.lang.String... args) Indicates that the item is to be exported.
Invoice	findInvoiceId(java.lang.String... args) Associated Invoice.
static InvoicePayment	findInvoicePayment(DataSource ds, Contact customer, java.util.Date paymentDate, Product product, double amount) find a payment
static InvoicePaymentBreakDown	findKey(DataSource ds, int key) Find the target for this class by the primary key
InvoicePayment	findPaymentId(java.lang.String... args) Payment Id.
static InvoicePayment	findRequestedInvoicePayment(DataSource ds, Contact customer, java.util.Date paymentDate, Product product, double amount) find a payment for REQUESTED_DATE
double	getAmountApplied(java.lang.String... args)
java.lang.String	getBreakdownNumber(java.lang.String... args)
double	getCreditAmount(java.lang.String... args)
java.util.Date	getCreditDt(java.lang.String... args)
java.util.Date	getExportedTime(java.lang.String... args)
DBTriStateOption	getExportFg(java.lang.String... args)
int	getID(java.lang.String... args)
Invoice	getInvoice()
Invoice	getInvoiceId(java.lang.String... args)
InvoicePayment	getPayment()
InvoicePayment	getPaymentId(java.lang.String... args)
static DBQuery<InvoicePaymentBreakDown>	makeQuery(DataSource ds) Make a new QUERY for this class.
InvoicePaymentBreakDown	setAmountApplied(double value, java.lang.String... args)
InvoicePaymentBreakDown	setBreakdownNumber(java.lang.String value, java.lang.String... args)
InvoicePaymentBreakDown	setExportedTime(java.util.Date value, java.lang.String... args)
InvoicePaymentBreakDown	setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
InvoicePaymentBreakDown	setID(int value, java.lang.String... args)
InvoicePaymentBreakDown	setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
InvoicePaymentBreakDown	setPaymentId(com.aspc.dal.layers.aspc_app.invoice.InvoicePayment 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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCopy, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

InvoicePaymentBreakdown

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

InvoicePaymentBreakdown

Constructor Detail

InvoicePaymentBreakDown

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

Throws:

java.lang.Exception

getAmountApplied

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

setAmountApplied

@Nonnull
public InvoicePaymentBreakDown setAmountApplied(double value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getBreakdownNumber

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

setBreakdownNumber

@Nonnull
public InvoicePaymentBreakDown setBreakdownNumber(java.lang.String value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCreditAmount

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

getCreditDt

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

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

Throws:

java.lang.Exception

getInvoiceId

@CheckReturnValue
 @Nullable
public Invoice getInvoiceId(java.lang.String... args)

findInvoiceId

@CheckReturnValue
 @Nonnull
public final Invoice findInvoiceId(java.lang.String... args)
                                                        throws NotFoundException

Associated Invoice.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setInvoiceId

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

Throws:

java.lang.Exception

getPaymentId

@CheckReturnValue
 @Nullable
public InvoicePayment getPaymentId(java.lang.String... args)

findPaymentId

@CheckReturnValue
 @Nonnull
public final InvoicePayment findPaymentId(java.lang.String... args)
                                                               throws NotFoundException

Payment Id.

--> InvoicePayment (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoicePayment

Throws:

NotFoundException - InvoicePayment was not found

setPaymentId

@Nonnull
public InvoicePaymentBreakDown setPaymentId(com.aspc.dal.layers.aspc_app.invoice.InvoicePayment value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

create

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

getPayment

public InvoicePayment getPayment()

Returns:

the value

getInvoice

public Invoice getInvoice()

Returns:

the value

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

extDelete

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

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

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Additional access checking for READ access of this object.

Overrides:

extCheckReadAccess in class DBObject

Throws:

DBAccessException - No access to READ

See Also:

DBObject.checkReadAccess()

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for delete access of this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to modify

extGetDerivedValue

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

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

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

field - The field to get

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

findInvoicePayment

public static InvoicePayment findInvoicePayment(DataSource ds,
                                                Contact customer,
                                                java.util.Date paymentDate,
                                                Product product,
                                                double amount)
                                         throws java.lang.Exception

find a payment

Parameters:

ds - the data souce

customer -

paymentDate -

product -

amount -

Returns:

InvoicePayment matching payment if any

Throws:

java.lang.Exception - error

findRequestedInvoicePayment

public static InvoicePayment findRequestedInvoicePayment(DataSource ds,
                                                         Contact customer,
                                                         java.util.Date paymentDate,
                                                         Product product,
                                                         double amount)
                                                  throws java.lang.Exception

find a payment for REQUESTED_DATE

Parameters:

ds - the data source to search

customer - payment customer

paymentDate - requested date of payment

product - payment product

amount - payment amount

Returns:

InvoicePayment matching payment, null if none

Throws:

java.lang.Exception - error finding payment

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overridding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

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