com.aspc.Layers.aspc_app.Invoice

Class InvoicePayment

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.InvoicePayment

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

MembershipInvoicePayment

public class InvoicePayment
extends DBObject

Payment
Records a payment against an Invoice.
Payments can be accepted a number ways such as Credit Card, Cheque, Eftpos.
For Credit Card payments the system can not only record a payment already made, but can also process a direct debit through the bank's online payment gateway.

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 Records a payment against an Invoice.
static java.lang.String	DBCLASS_NAME Records a payment against an Invoice.
static java.lang.String	DBFIELD_EXPORT_FG Indicates that the Invoice is to be exported.
static java.lang.String	DBFIELD_EXPORTED_TIME Time that this invoice was last exported.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
InvoicePayment(DBClass def, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static InvoicePayment	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	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	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 boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected boolean	extIsOnChange(DBField field) override on change.
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.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Account	findAccount(java.lang.String... args) The asset account into which you want to apply the payment.
BankAccount	findBankAccount(java.lang.String... args) Account.
java.lang.Object	findBankRejectReason(java.lang.String... args) The bank reject reason.
Bsb	findBsb(java.lang.String... args) bsb number.
CreditCardType	findCreditCardType(java.lang.String... args) Credit Card Type.
Contact	findCustomer(java.lang.String... args) The Customer who made this payment.
DBTriStateOption	findDirectDebit(java.lang.String... args) directDebit if set to false, do not process direct debit.
Person	findDirectDebitFailureCheckedBy(java.lang.String... args) Person that checked the failure.
DirectDebitStatus	findDirectDebitStatus(java.lang.String... args) The status of the direct debit processing for this payment.
Person	findEnteredBy(java.lang.String... args) Entered By.
DBTriStateOption	findEwayTrxnStatus(java.lang.String... args) This value is returned to your website.
Invoice	findInvoiceId(java.lang.String... args) Allows full amount to be applied to one invoice.
static InvoicePayment	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.
PaymentMethod	findPaymentMethod(java.lang.String... args) The method in which the payment was received.
PaymentSource	findPaymentSource(java.lang.String... args) Payment Source.
java.lang.Object	findPaymentType(java.lang.String... args) The purpose of the payment.
ProcessStatus	findProcessStatus(java.lang.String... args) 3 phase update status.
protected AccountJournalSet	generateJournalSet(boolean reversal) Generates a new journal set to match current totals for invoice
Account	getAccount(java.lang.String... args)
double	getAmount(java.lang.String... args)
java.util.Date	getAuthGivenDate(java.lang.String... args)
BankAccount	getBankAccount(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)
java.lang.String	getBankCardAuthNum(java.lang.String... args)
java.lang.String	getBankCardDisplayNumber(java.lang.String... args)
java.util.Date	getBankCardExpiry(java.lang.String... args)
java.lang.String	getBankCardName(java.lang.String... args)
java.lang.String	getBankCardNewNumber(java.lang.String... args)
java.lang.String	getBankCardNum(java.lang.String... args)
java.lang.String	getBankName(java.lang.String... args)
java.lang.Object	getBankRejectReason(java.lang.String... args)
java.util.Date	getBankStatDate(java.lang.String... args)
DBObject[]	getBreakDown() Product invoice breakdown structure
Bsb	getBsb(java.lang.String... args)
java.util.Date	getChequeDate(java.lang.String... args)
java.lang.String	getChequeNumber(java.lang.String... args)
CreditCardType	getCreditCardType(java.lang.String... args)
Contact	getCustomer(java.lang.String... args)
DBTriStateOption	getDirectDebit(java.lang.String... args)
Person	getDirectDebitFailureCheckedBy(java.lang.String... args)
java.lang.String	getDirectDebitFailureCheckedNote(java.lang.String... args)
java.lang.String	getDirectDebitJobQueue(java.lang.String... args)
java.lang.String	getDirectDebitRefCode(java.lang.String... args)
java.lang.String	getDirectDebitResponseCode(java.lang.String... args)
java.lang.String	getDirectDebitResponseText(java.lang.String... args)
java.util.Date	getDirectDebitSettlementDate(java.lang.String... args)
DirectDebitStatus	getDirectDebitStatus(java.lang.String... args)
java.lang.String	getDirectDebitTransRef(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnterTime(java.lang.String... args)
java.lang.String	getEwayAuthCode(java.lang.String... args)
java.lang.String	getEwayOriginalRefundTrxn(java.lang.String... args)
java.lang.String	getEwayTrxnNumber(java.lang.String... args)
DBTriStateOption	getEwayTrxnStatus(java.lang.String... args)
java.lang.String	getEwayTxnError(java.lang.String... args)
double	getExpectedAmount(java.lang.String... args)
double	getFinanceCharge(java.lang.String... args)
int	getID(java.lang.String... args)
Invoice	getInvoiceId(java.lang.String... args)
java.lang.String	getIsLocked(java.lang.String... args)
DBObject[]	getJournalEntries() Return all journal entries related to this invoice
double	getJournalTotalIncome() calculates the journal account total income
java.lang.String	getMemo(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
java.util.Date	getPaymentDt(java.lang.String... args)
PaymentMethod	getPaymentMethod(java.lang.String... args)
java.lang.String	getPaymentNumber(java.lang.String... args)
PaymentSource	getPaymentSource(java.lang.String... args)
java.lang.Object	getPaymentType(java.lang.String... args)
java.util.Date	getProcessedDate(java.lang.String... args)
ProcessStatus	getProcessStatus(java.lang.String... args)
double	getRawAmount(java.lang.String... args)
java.util.Date	getRequestedDate(java.lang.String... args)
java.util.Date	getReversedDate(java.lang.String... args)
java.lang.String	getReversedReason(java.lang.String... args)
java.lang.String	getStatus() Gets the direct debit status string for this payment
double	getTaxAmount(java.lang.String... args)
double	getUnallocated(java.lang.String... args)
boolean	isDetached(java.lang.String... args)
boolean	isDirectDebitFailureChecked(java.lang.String... args)
boolean	isEmailReceipt(java.lang.String... args)
boolean	isLocked() checking if locked or not
protected boolean	isModifiableWhenLocked(DBField field) Checks if modifiable when locked
boolean	isReversed() checking if reverse or not
boolean	isReversedFg(java.lang.String... args)
static DBQuery<InvoicePayment>	makeQuery(DataSource ds) Make a new QUERY for this class.
InvoicePayment	setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value, java.lang.String... args)
InvoicePayment	setAuthGivenDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount value, java.lang.String... args)
InvoicePayment	setBankAccountName(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankAccountNum(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankBSB(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankCardAuthNum(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankCardExpiry(java.util.Date value, java.lang.String... args)
InvoicePayment	setBankCardName(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankCardNewNumber(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankCardNum(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankName(java.lang.String value, java.lang.String... args)
InvoicePayment	setBankRejectReason(java.lang.Object value, java.lang.String... args)
InvoicePayment	setBankStatDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setBsb(com.aspc.dal.layers.aspc_app.bsb.Bsb value, java.lang.String... args)
InvoicePayment	setChequeDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setChequeNumber(java.lang.String value, java.lang.String... args)
InvoicePayment	setCreditCardType(com.aspc.dal.layers.aspc_app.misc.CreditCardType value, java.lang.String... args)
InvoicePayment	setCustomer(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
InvoicePayment	setDetached(boolean value, java.lang.String... args)
InvoicePayment	setDirectDebit(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
InvoicePayment	setDirectDebitFailureChecked(boolean value, java.lang.String... args)
InvoicePayment	setDirectDebitFailureCheckedBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
InvoicePayment	setDirectDebitFailureCheckedNote(java.lang.String value, java.lang.String... args)
InvoicePayment	setDirectDebitJobQueue(java.lang.String value, java.lang.String... args)
InvoicePayment	setDirectDebitRefCode(java.lang.String value, java.lang.String... args)
InvoicePayment	setDirectDebitResponseCode(java.lang.String value, java.lang.String... args)
InvoicePayment	setDirectDebitResponseText(java.lang.String value, java.lang.String... args)
InvoicePayment	setDirectDebitSettlementDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setDirectDebitStatus(com.aspc.dal.layers.aspc_app.directdebit.DirectDebitStatus value, java.lang.String... args)
InvoicePayment	setDirectDebitTransRef(java.lang.String value, java.lang.String... args)
InvoicePayment	setEmailReceipt(boolean value, java.lang.String... args)
InvoicePayment	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
InvoicePayment	setEnterTime(java.util.Date value, java.lang.String... args)
InvoicePayment	setEwayAuthCode(java.lang.String value, java.lang.String... args)
InvoicePayment	setEwayOriginalRefundTrxn(java.lang.String value, java.lang.String... args)
InvoicePayment	setEwayTrxnNumber(java.lang.String value, java.lang.String... args)
InvoicePayment	setEwayTrxnStatus(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
InvoicePayment	setEwayTxnError(java.lang.String value, java.lang.String... args)
InvoicePayment	setFinanceCharge(double value, java.lang.String... args)
InvoicePayment	setID(int value, java.lang.String... args)
InvoicePayment	setInvoiceId(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
InvoicePayment	setMemo(java.lang.String value, java.lang.String... args)
InvoicePayment	setNotes(java.lang.String value, java.lang.String... args)
InvoicePayment	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
InvoicePayment	setPaymentDt(java.util.Date value, java.lang.String... args)
InvoicePayment	setPaymentMethod(com.aspc.dal.layers.aspc_app.invoice.PaymentMethod value, java.lang.String... args)
InvoicePayment	setPaymentNumber(java.lang.String value, java.lang.String... args)
InvoicePayment	setPaymentSource(com.aspc.dal.layers.aspc_app.invoice.PaymentSource value, java.lang.String... args)
InvoicePayment	setPaymentType(java.lang.Object value, java.lang.String... args)
InvoicePayment	setProcessedDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setProcessStatus(com.aspc.dal.layers.aspc_app.misc.ProcessStatus value, java.lang.String... args)
InvoicePayment	setRawAmount(double value, java.lang.String... args)
InvoicePayment	setRequestedDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setReversedDate(java.util.Date value, java.lang.String... args)
InvoicePayment	setReversedFg(boolean value, java.lang.String... args)
InvoicePayment	setReversedReason(java.lang.String value, java.lang.String... args)
InvoicePayment	setTaxAmount(double value, java.lang.String... args)
static java.lang.String	trimCardNumber(java.lang.String cardNumber)
protected void	updatePaymentNumber() function to update payment number
protected void	updateProcessedDate() updates the processed date

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, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, 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

Records a payment against an Invoice.
Payments can be accepted a number ways such as Credit Card, Cheque, Eftpos.
For Credit Card payments the system can not only record a payment already made, but can also process a direct debit through the bank's online payment gateway.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Records a payment against an Invoice.
Payments can be accepted a number ways such as Credit Card, Cheque, Eftpos.
For Credit Card payments the system can not only record a payment already made, but can also process a direct debit through the bank's online payment gateway.

DBFIELD_EXPORT_FG

public static final java.lang.String DBFIELD_EXPORT_FG

Indicates that the Invoice is to be exported.

--> DBTriStateOption (String, Searchable)

See Also:

Constant Field Values

DBFIELD_EXPORTED_TIME

public static final java.lang.String DBFIELD_EXPORTED_TIME

Time that this invoice was last exported.

(Timestamp)

See Also:

Constant Field Values

Constructor Detail

InvoicePayment

public InvoicePayment(DBClass def,
                      DataSource dataSource)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getID

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

setID

@Nonnull
public InvoicePayment 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

The asset account into which you want to apply the payment.

--> Account (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Account

Throws:

NotFoundException - Account was not found

setAccount

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

Throws:

java.lang.Exception

getAmount

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

getAuthGivenDate

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

setAuthGivenDate

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

Throws:

java.lang.Exception

getBankAccount

@CheckReturnValue
 @Nullable
public BankAccount getBankAccount(java.lang.String... args)

findBankAccount

@CheckReturnValue
 @Nonnull
public final BankAccount findBankAccount(java.lang.String... args)
                                                              throws NotFoundException

Account.

--> BankAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

BankAccount

Throws:

NotFoundException - BankAccount was not found

setBankAccount

@Nonnull
public InvoicePayment setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount 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 InvoicePayment 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 InvoicePayment 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 InvoicePayment setBankBSB(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getBankCardAuthNum

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

setBankCardAuthNum

@Nonnull
public InvoicePayment setBankCardAuthNum(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getBankCardDisplayNumber

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

getBankCardExpiry

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

setBankCardExpiry

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

Throws:

java.lang.Exception

getBankCardName

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

setBankCardName

@Nonnull
public InvoicePayment setBankCardName(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getBankCardNewNumber

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

setBankCardNewNumber

@Nonnull
public InvoicePayment setBankCardNewNumber(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getBankCardNum

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

setBankCardNum

@Nonnull
public InvoicePayment setBankCardNum(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getBankName

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

setBankName

@Nonnull
public InvoicePayment setBankName(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getBankRejectReason

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

findBankRejectReason

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

The bank reject reason.

--> PaymentRejectReason (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentRejectReason

Throws:

NotFoundException - PaymentRejectReason was not found

setBankRejectReason

@Nonnull
public InvoicePayment setBankRejectReason(java.lang.Object value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getBankStatDate

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

setBankStatDate

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

Throws:

java.lang.Exception

getBsb

@CheckReturnValue
 @Nullable
public Bsb getBsb(java.lang.String... args)

findBsb

@CheckReturnValue
 @Nonnull
public final Bsb findBsb(java.lang.String... args)
                                              throws NotFoundException

bsb number.

--> Bsb (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Bsb

Throws:

NotFoundException - Bsb was not found

setBsb

@Nonnull
public InvoicePayment setBsb(com.aspc.dal.layers.aspc_app.bsb.Bsb value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getChequeDate

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

setChequeDate

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

Throws:

java.lang.Exception

getChequeNumber

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

setChequeNumber

@Nonnull
public InvoicePayment setChequeNumber(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getCreditCardType

@CheckReturnValue
 @Nullable
public CreditCardType getCreditCardType(java.lang.String... args)

findCreditCardType

@CheckReturnValue
 @Nonnull
public final CreditCardType findCreditCardType(java.lang.String... args)
                                                                    throws NotFoundException

Credit Card Type.

--> CreditCardType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

CreditCardType

Throws:

NotFoundException - CreditCardType was not found

setCreditCardType

@Nonnull
public InvoicePayment setCreditCardType(com.aspc.dal.layers.aspc_app.misc.CreditCardType 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

The Customer who made this payment.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setCustomer

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

Throws:

java.lang.Exception

isDetached

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

setDetached

@Nonnull
public InvoicePayment setDetached(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebit

@CheckReturnValue
 @Nullable
public DBTriStateOption getDirectDebit(java.lang.String... args)

findDirectDebit

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findDirectDebit(java.lang.String... args)
                                                                   throws NotFoundException

directDebit if set to false, do not process direct debit.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setDirectDebit

@Nonnull
public InvoicePayment setDirectDebit(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isDirectDebitFailureChecked

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

setDirectDebitFailureChecked

@Nonnull
public InvoicePayment setDirectDebitFailureChecked(boolean value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitFailureCheckedBy

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

findDirectDebitFailureCheckedBy

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

Person that checked the failure.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setDirectDebitFailureCheckedBy

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

Throws:

java.lang.Exception

getDirectDebitFailureCheckedNote

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

setDirectDebitFailureCheckedNote

@Nonnull
public InvoicePayment setDirectDebitFailureCheckedNote(java.lang.String value,
                                                                java.lang.String... args)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitJobQueue

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

setDirectDebitJobQueue

@Nonnull
public InvoicePayment setDirectDebitJobQueue(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitRefCode

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

setDirectDebitRefCode

@Nonnull
public InvoicePayment setDirectDebitRefCode(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitResponseCode

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

setDirectDebitResponseCode

@Nonnull
public InvoicePayment setDirectDebitResponseCode(java.lang.String value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitResponseText

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

setDirectDebitResponseText

@Nonnull
public InvoicePayment setDirectDebitResponseText(java.lang.String value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitSettlementDate

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

setDirectDebitSettlementDate

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

Throws:

java.lang.Exception

getDirectDebitStatus

@CheckReturnValue
 @Nullable
public DirectDebitStatus getDirectDebitStatus(java.lang.String... args)

findDirectDebitStatus

@CheckReturnValue
 @Nonnull
public final DirectDebitStatus findDirectDebitStatus(java.lang.String... args)
                                                                          throws NotFoundException

The status of the direct debit processing for this payment.

--> DirectDebitStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DirectDebitStatus

Throws:

NotFoundException - DirectDebitStatus was not found

setDirectDebitStatus

@Nonnull
public InvoicePayment setDirectDebitStatus(com.aspc.dal.layers.aspc_app.directdebit.DirectDebitStatus value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getDirectDebitTransRef

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

setDirectDebitTransRef

@Nonnull
public InvoicePayment setDirectDebitTransRef(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

isEmailReceipt

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

setEmailReceipt

@Nonnull
public InvoicePayment setEmailReceipt(boolean 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 InvoicePayment 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

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

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

Throws:

java.lang.Exception

getEwayAuthCode

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

setEwayAuthCode

@Nonnull
public InvoicePayment setEwayAuthCode(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getEwayOriginalRefundTrxn

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

setEwayOriginalRefundTrxn

@Nonnull
public InvoicePayment setEwayOriginalRefundTrxn(java.lang.String value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getEwayTrxnNumber

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

setEwayTrxnNumber

@Nonnull
public InvoicePayment setEwayTrxnNumber(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getEwayTrxnStatus

@CheckReturnValue
 @Nullable
public DBTriStateOption getEwayTrxnStatus(java.lang.String... args)

findEwayTrxnStatus

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findEwayTrxnStatus(java.lang.String... args)
                                                                      throws NotFoundException

This value is returned to your website. For a successful transaction
"True" is passed and for a failed transaction "False" is passed.
This allows you to make your own logging on your website for
transaction status.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setEwayTrxnStatus

@Nonnull
public InvoicePayment setEwayTrxnStatus(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getEwayTxnError

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

setEwayTxnError

@Nonnull
public InvoicePayment setEwayTxnError(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getExpectedAmount

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

getFinanceCharge

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

setFinanceCharge

@Nonnull
public InvoicePayment setFinanceCharge(double 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

Allows full amount to be applied to one invoice.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setInvoiceId

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

Throws:

java.lang.Exception

getIsLocked

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

getMemo

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

setMemo

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

Throws:

java.lang.Exception

getNotes

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

setNotes

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

Throws:

java.lang.Exception

getPaymentDt

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

setPaymentDt

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

Throws:

java.lang.Exception

getPaymentMethod

@CheckReturnValue
 @Nullable
public PaymentMethod getPaymentMethod(java.lang.String... args)

findPaymentMethod

@CheckReturnValue
 @Nonnull
public final PaymentMethod findPaymentMethod(java.lang.String... args)
                                                                  throws NotFoundException

The method in which the payment was received. For example Cash, Cheque, Credit Card, etc.

--> PaymentMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentMethod

Throws:

NotFoundException - PaymentMethod was not found

setPaymentMethod

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

Throws:

java.lang.Exception

getPaymentNumber

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

setPaymentNumber

@Nonnull
public InvoicePayment setPaymentNumber(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentSource

@CheckReturnValue
 @Nullable
public PaymentSource getPaymentSource(java.lang.String... args)

findPaymentSource

@CheckReturnValue
 @Nonnull
public final PaymentSource findPaymentSource(java.lang.String... args)
                                                                  throws NotFoundException

Payment Source.

--> PaymentSource (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentSource

Throws:

NotFoundException - PaymentSource was not found

setPaymentSource

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

Throws:

java.lang.Exception

getPaymentType

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

findPaymentType

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

The purpose of the payment. For example, Deposit or Balance.

--> PaymentType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentType

Throws:

NotFoundException - PaymentType was not found

setPaymentType

@Nonnull
public InvoicePayment setPaymentType(java.lang.Object value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getProcessStatus

@CheckReturnValue
 @Nullable
public ProcessStatus getProcessStatus(java.lang.String... args)

findProcessStatus

@CheckReturnValue
 @Nonnull
public final ProcessStatus findProcessStatus(java.lang.String... args)
                                                                  throws NotFoundException

3 phase update status.

--> ProcessStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ProcessStatus

Throws:

NotFoundException - ProcessStatus was not found

setProcessStatus

@Nonnull
public InvoicePayment setProcessStatus(com.aspc.dal.layers.aspc_app.misc.ProcessStatus value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getProcessedDate

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

setProcessedDate

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

Throws:

java.lang.Exception

getRequestedDate

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

setRequestedDate

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

Throws:

java.lang.Exception

getReversedDate

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

setReversedDate

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

Throws:

java.lang.Exception

isReversedFg

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

setReversedFg

@Nonnull
public InvoicePayment setReversedFg(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getReversedReason

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

setReversedReason

@Nonnull
public InvoicePayment setReversedReason(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getTaxAmount

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

setTaxAmount

@Nonnull
public InvoicePayment setTaxAmount(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 InvoicePayment 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<InvoicePayment> 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 InvoicePayment 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

getBreakDown

public DBObject[] getBreakDown()
                        throws java.lang.Exception

Product invoice breakdown structure

Returns:

object

Throws:

java.lang.Exception

getJournalEntries

public DBObject[] getJournalEntries()
                             throws java.lang.Exception

Return all journal entries related to this invoice

Returns:

object

Throws:

java.lang.Exception

isLocked

public final boolean isLocked()

checking if locked or not

Returns:

boolean value

isReversed

public boolean isReversed()
                   throws NotFoundException

checking if reverse or not

Returns:

boolean value

Throws:

NotFoundException

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

override on change.

Overrides:

extIsOnChange in class DBObject

Parameters:

field - pass the field

Returns:

boolean value

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

updatePaymentNumber

protected void updatePaymentNumber()
                            throws java.lang.Exception

function to update payment number

Throws:

java.lang.Exception - a serious problem

updateProcessedDate

protected void updateProcessedDate()
                            throws java.lang.Exception

updates the processed date

Throws:

java.lang.Exception - an error

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

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

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

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

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

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 - field value

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 delete

isModifiableWhenLocked

protected boolean isModifiableWhenLocked(DBField field)

Checks if modifiable when locked

Parameters:

field - field is passed

Returns:

boolean value

generateJournalSet

protected AccountJournalSet generateJournalSet(boolean reversal)
                                        throws java.lang.Exception

Generates a new journal set to match current totals for invoice

Parameters:

reversal - reversal boolean value

Returns:

AcoountJournalSet object

Throws:

java.lang.Exception - a serious problem

getJournalTotalIncome

public double getJournalTotalIncome()
                             throws java.lang.Exception

calculates the journal account total income

Returns:

total income

Throws:

java.lang.Exception

getStatus

public java.lang.String getStatus()

Gets the direct debit status string for this payment

Returns:

String the direct debit status

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

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

trimCardNumber

public static java.lang.String trimCardNumber(java.lang.String cardNumber)

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