com.aspc.Layers.aspc_app.Purchase

Class PurchasePayment

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Purchase.PurchasePayment

All Implemented Interfaces:

SecondaryCacheGroup

public class PurchasePayment
extends DBObject

Payment
Generic DBObject.

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

Since:

November 10 2003

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID PurchasePayment
static java.lang.String	DBCLASS_NAME PurchasePayment

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PurchasePayment	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	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
Account	findAccount(java.lang.String... args) Journal Account.
BankAccount	findBankAccount(java.lang.String... args) Bank Account.
Person	findEnteredBy(java.lang.String... args) Person that created the payment.
static PurchasePayment	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) Method used to make payment, i.e Eftpos --> PaymentMethod (String, Searchable)
Purchase	findPurchaseId(java.lang.String... args) Associated purchase.
java.lang.Object	findStatus(java.lang.String... args) Purchase payment status.
Contact	findSupplier(java.lang.String... args) Associated Supplier.
Account	getAccount(java.lang.String... args)
BankAccount	getBankAccount(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnteredTime(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMemo(java.lang.String... args)
java.util.Date	getModifiedTime(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)
java.util.Date	getProcessedTime(java.lang.String... args)
Purchase	getPurchaseId(java.lang.String... args)
double	getRawAmount(java.lang.String... args)
java.lang.Object	getStatus(java.lang.String... args)
Contact	getSupplier(java.lang.String... args)
double	getUnallocated(java.lang.String... args)
static DBQuery<PurchasePayment>	makeQuery(DataSource ds) Make a new QUERY for this class.
PurchasePayment	setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value, java.lang.String... args)
PurchasePayment	setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount value, java.lang.String... args)
PurchasePayment	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
PurchasePayment	setEnteredTime(java.util.Date value, java.lang.String... args)
PurchasePayment	setID(int value, java.lang.String... args)
PurchasePayment	setMemo(java.lang.String value, java.lang.String... args)
PurchasePayment	setModifiedTime(java.util.Date value, java.lang.String... args)
PurchasePayment	setNotes(java.lang.String value, java.lang.String... args)
PurchasePayment	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
PurchasePayment	setPaymentDt(java.util.Date value, java.lang.String... args)
PurchasePayment	setPaymentMethod(com.aspc.dal.layers.aspc_app.invoice.PaymentMethod value, java.lang.String... args)
PurchasePayment	setPaymentNumber(java.lang.String value, java.lang.String... args)
PurchasePayment	setProcessedTime(java.util.Date value, java.lang.String... args)
PurchasePayment	setPurchaseId(com.aspc.dal.layers.aspc_app.purchase.Purchase value, java.lang.String... args)
PurchasePayment	setRawAmount(double value, java.lang.String... args)
PurchasePayment	setStatus(java.lang.Object value, java.lang.String... args)
PurchasePayment	setSupplier(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
protected void	updatePaymentNumber()

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

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

PurchasePayment

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

PurchasePayment

Constructor Detail

PurchasePayment

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

Journal Account.

--> Account (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Account

Throws:

NotFoundException - Account was not found

setAccount

@Nonnull
public PurchasePayment setAccount(com.aspc.dal.layers.aspc_app.accounts.Account 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

Bank Account.

--> BankAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

BankAccount

Throws:

NotFoundException - BankAccount was not found

setBankAccount

@Nonnull
public PurchasePayment setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount 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

Person that created the payment.

--> Person (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

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

Throws:

java.lang.Exception

getEnteredTime

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

setEnteredTime

@Nonnull
public PurchasePayment setEnteredTime(java.util.Date 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 PurchasePayment setMemo(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getModifiedTime

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

setModifiedTime

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

Method used to make payment, i.e Eftpos

--> PaymentMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentMethod

Throws:

NotFoundException - PaymentMethod was not found

setPaymentMethod

@Nonnull
public PurchasePayment 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 PurchasePayment setPaymentNumber(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getProcessedTime

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

setProcessedTime

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

Throws:

java.lang.Exception

getPurchaseId

@CheckReturnValue
 @Nullable
public Purchase getPurchaseId(java.lang.String... args)

findPurchaseId

@CheckReturnValue
 @Nonnull
public final Purchase findPurchaseId(java.lang.String... args)
                                                          throws NotFoundException

Associated purchase.

--> Purchase (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Purchase

Throws:

NotFoundException - Purchase was not found

setPurchaseId

@Nonnull
public PurchasePayment setPurchaseId(com.aspc.dal.layers.aspc_app.purchase.Purchase 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 PurchasePayment setRawAmount(double value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

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

findStatus

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

Purchase payment status.

--> PurchasePaymentStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PurchasePaymentStatus

Throws:

NotFoundException - PurchasePaymentStatus was not found

setStatus

@Nonnull
public PurchasePayment setStatus(java.lang.Object value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSupplier

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

findSupplier

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

Associated Supplier.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setSupplier

@Nonnull
public PurchasePayment setSupplier(com.aspc.dal.dbobj.contact.Contact 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 PurchasePayment 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<PurchasePayment> 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 PurchasePayment 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

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

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

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

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

Throws:

java.lang.Exception - a serious problem