com.aspc.Layers.aspc_app.processes

Class DeductionBatch

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.processes.DeductionBatch

All Implemented Interfaces:

SecondaryCacheGroup

public class DeductionBatch
extends DBObject

Store the Deduction Batch values.

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

Since:

2010/03/31

Author:

anitha

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 Store the Deduction Batch values
static java.lang.String	DBCLASS_NAME Store the Deduction Batch values

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DeductionBatch	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	extDelete() Additional functionality when an object is marked for deletion by calling delete().
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 void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
Bsb	findBsb(java.lang.String... args) The bsb number.
Employer	findEmployer(java.lang.String... args) deduction batch for the employer.
Employer	findEmployer2(java.lang.String... args) Employer 2 for the deduction batch.
static DeductionBatch	findKey(DataSource ds, int key) Find the target for this class by the primary key
PaymentFrequency	findRemitFrequency(java.lang.String... args) remmitance frequency.
PaymentMethod	findRemitMethod(java.lang.String... args) remmittance method.
MemberType	findRemitMType(java.lang.String... args) remmitance mtype.
ProcessBatchPayments	genProcessBatch() Generate Process batch payments.
double	getAmountPlusCommission(java.lang.String... args)
int	getBatchNo(java.lang.String... args)
Bsb	getBsb(java.lang.String... args)
double	getCommisionPercent(java.lang.String... args)
java.util.Date	getCreatedDate(java.lang.String... args)
Employer	getEmployer(java.lang.String... args)
Employer	getEmployer2(java.lang.String... args)
java.lang.String	getErrors(java.lang.String... args)
double	getGst(java.lang.String... args)
java.lang.String	getProcessingMessage(java.lang.String... args)
double	getRemitAmount(java.lang.String... args)
double	getRemitAmountT2(java.lang.String... args)
java.util.Date	getRemitBanked(java.lang.String... args)
int	getRemitChqReference(java.lang.String... args)
double	getRemitCommision(java.lang.String... args)
double	getRemitCredit(java.lang.String... args)
PaymentFrequency	getRemitFrequency(java.lang.String... args)
java.util.Date	getRemitFrom(java.lang.String... args)
PaymentMethod	getRemitMethod(java.lang.String... args)
MemberType	getRemitMType(java.lang.String... args)
int	getRemitPeriod(java.lang.String... args)
java.lang.String	getRemitSort(java.lang.String... args)
java.util.Date	getRemitTo(java.lang.String... args)
int	getRemitYear(java.lang.String... args)
java.lang.String	getStatus(java.lang.String... args)
java.lang.String	getWarning(java.lang.String... args)
boolean	isPayCommision(java.lang.String... args)
boolean	isWasCommissionTaken(java.lang.String... args)
static DBQuery<DeductionBatch>	makeQuery(DataSource ds) Make a new QUERY for this class.
DeductionBatch	setBatchNo(int value, java.lang.String... args)
DeductionBatch	setBsb(com.aspc.dal.layers.aspc_app.bsb.Bsb value, java.lang.String... args)
DeductionBatch	setCommisionPercent(double value, java.lang.String... args)
DeductionBatch	setCreatedDate(java.util.Date value, java.lang.String... args)
DeductionBatch	setEmployer(com.aspc.dal.layers.aspc_app.employer.Employer value, java.lang.String... args)
DeductionBatch	setEmployer2(com.aspc.dal.layers.aspc_app.employer.Employer value, java.lang.String... args)
DeductionBatch	setErrors(java.lang.String value, java.lang.String... args)
DeductionBatch	setGst(double value, java.lang.String... args)
DeductionBatch	setPayCommision(boolean value, java.lang.String... args)
DeductionBatch	setProcessingMessage(java.lang.String value, java.lang.String... args)
DeductionBatch	setRemitAmount(double value, java.lang.String... args)
DeductionBatch	setRemitBanked(java.util.Date value, java.lang.String... args)
DeductionBatch	setRemitChqReference(int value, java.lang.String... args)
DeductionBatch	setRemitCommision(double value, java.lang.String... args)
DeductionBatch	setRemitCredit(double value, java.lang.String... args)
DeductionBatch	setRemitFrequency(com.aspc.dal.layers.aspc_app.invoice.PaymentFrequency value, java.lang.String... args)
DeductionBatch	setRemitFrom(java.util.Date value, java.lang.String... args)
DeductionBatch	setRemitMethod(com.aspc.dal.layers.aspc_app.invoice.PaymentMethod value, java.lang.String... args)
DeductionBatch	setRemitMType(com.aspc.dal.layers.aspc_app.member.MemberType value, java.lang.String... args)
DeductionBatch	setRemitPeriod(int value, java.lang.String... args)
DeductionBatch	setRemitSort(java.lang.String value, java.lang.String... args)
DeductionBatch	setRemitTo(java.util.Date value, java.lang.String... args)
DeductionBatch	setRemitYear(int value, java.lang.String... args)
DeductionBatch	setStatus(java.lang.String value, java.lang.String... args)
DeductionBatch	setWasCommissionTaken(boolean value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

Store the Deduction Batch values

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Store the Deduction Batch values

Constructor Detail

DeductionBatch

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

getBatchNo

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

setBatchNo

@Nonnull
public DeductionBatch setBatchNo(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getAmountPlusCommission

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

getBsb

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

findBsb

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

The bsb number.

--> Bsb (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Bsb

Throws:

NotFoundException - Bsb was not found

setBsb

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

Throws:

java.lang.Exception

getCommisionPercent

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

setCommisionPercent

@Nonnull
public DeductionBatch setCommisionPercent(double value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedDate

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

setCreatedDate

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

Throws:

java.lang.Exception

getEmployer

@CheckReturnValue
 @Nullable
public Employer getEmployer(java.lang.String... args)

findEmployer

@CheckReturnValue
 @Nonnull
public final Employer findEmployer(java.lang.String... args)
                                                        throws NotFoundException

deduction batch for the employer.

--> Employer (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Employer

Throws:

NotFoundException - Employer was not found

setEmployer

@Nonnull
public DeductionBatch setEmployer(com.aspc.dal.layers.aspc_app.employer.Employer value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getEmployer2

@CheckReturnValue
 @Nullable
public Employer getEmployer2(java.lang.String... args)

findEmployer2

@CheckReturnValue
 @Nonnull
public final Employer findEmployer2(java.lang.String... args)
                                                         throws NotFoundException

Employer 2 for the deduction batch.

--> Employer (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Employer

Throws:

NotFoundException - Employer was not found

setEmployer2

@Nonnull
public DeductionBatch setEmployer2(com.aspc.dal.layers.aspc_app.employer.Employer value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getErrors

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

setErrors

@Nonnull
public DeductionBatch setErrors(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getGst

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

setGst

@Nonnull
public DeductionBatch setGst(double value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isPayCommision

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

setPayCommision

@Nonnull
public DeductionBatch setPayCommision(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getProcessingMessage

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

setProcessingMessage

@Nonnull
public DeductionBatch setProcessingMessage(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRemitAmount

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

setRemitAmount

@Nonnull
public DeductionBatch setRemitAmount(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRemitAmountT2

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

getRemitBanked

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

setRemitBanked

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

Throws:

java.lang.Exception

getRemitChqReference

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

setRemitChqReference

@Nonnull
public DeductionBatch setRemitChqReference(int value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRemitCommision

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

setRemitCommision

@Nonnull
public DeductionBatch setRemitCommision(double value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getRemitCredit

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

setRemitCredit

@Nonnull
public DeductionBatch setRemitCredit(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRemitFrequency

@CheckReturnValue
 @Nullable
public PaymentFrequency getRemitFrequency(java.lang.String... args)

findRemitFrequency

@CheckReturnValue
 @Nonnull
public final PaymentFrequency findRemitFrequency(java.lang.String... args)
                                                                      throws NotFoundException

remmitance frequency.

--> PaymentFrequency (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentFrequency

Throws:

NotFoundException - PaymentFrequency was not found

setRemitFrequency

@Nonnull
public DeductionBatch setRemitFrequency(com.aspc.dal.layers.aspc_app.invoice.PaymentFrequency value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getRemitFrom

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

setRemitFrom

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

Throws:

java.lang.Exception

getRemitMType

@CheckReturnValue
 @Nullable
public MemberType getRemitMType(java.lang.String... args)

findRemitMType

@CheckReturnValue
 @Nonnull
public final MemberType findRemitMType(java.lang.String... args)
                                                            throws NotFoundException

remmitance mtype.

--> MemberType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MemberType

Throws:

NotFoundException - MemberType was not found

setRemitMType

@Nonnull
public DeductionBatch setRemitMType(com.aspc.dal.layers.aspc_app.member.MemberType value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRemitMethod

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

findRemitMethod

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

remmittance method.

--> PaymentMethod (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentMethod

Throws:

NotFoundException - PaymentMethod was not found

setRemitMethod

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

Throws:

java.lang.Exception

getRemitPeriod

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

setRemitPeriod

@Nonnull
public DeductionBatch setRemitPeriod(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRemitSort

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

setRemitSort

@Nonnull
public DeductionBatch setRemitSort(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRemitTo

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

setRemitTo

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

Throws:

java.lang.Exception

getRemitYear

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

setRemitYear

@Nonnull
public DeductionBatch setRemitYear(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

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

setStatus

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

Throws:

java.lang.Exception

getWarning

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

isWasCommissionTaken

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

setWasCommissionTaken

@Nonnull
public DeductionBatch setWasCommissionTaken(boolean value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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)

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

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

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

genProcessBatch

public ProcessBatchPayments genProcessBatch()
                                     throws java.lang.Exception

Generate Process batch payments.

Returns:

ProcessBatchPayments

Throws:

java.lang.Exception - exception

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