com.aspc.Layers.aspc_app.Membership

Class MembershipRates

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Membership.MembershipRates

All Implemented Interfaces:

SecondaryCacheGroup

public class MembershipRates
extends DBObject

Membership Rates.

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

Since:

$Date: 2014-12-18 01:51:40 $

Author:

Liam

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 Membership Rates
static java.lang.String	DBCLASS_NAME Membership Rates
static java.lang.String	PARAM_TODAY for testing purpose only

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static MembershipRates	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
static MembershipRates	findKey(DataSource ds, int key) Find the target for this class by the primary key
MemberType	findMtype(java.lang.String... args) Member type.
double	getAdjustFortnightlyIncludingTax(java.lang.String... args)
double	getAdjustHalfYearlyIncludingTax(java.lang.String... args)
double	getAdjustMonthlyIncludingTax(java.lang.String... args)
double	getAdjustQuarterlyIncludingTax(java.lang.String... args)
double	getAnnualDisc(java.lang.String... args)
double	getAnnualDiscIncludingTax(java.lang.String... args)
double	getAnnualDiscountRateToday(java.lang.String... args)
double	getAnnualRate(java.lang.String... args)
double	getAnnualRateIncludingTax(java.lang.String... args)
static double	getAnnualRelativeRate(DBObject classification, DBObject memberType)
int	getDiscDay(java.lang.String... args)
int	getDiscMonth(java.lang.String... args)
double	getFortnightlyIncludingTax(java.lang.String... args)
double	getHalfYearlyIncludingTax(java.lang.String... args)
int	getID(java.lang.String... args)
double	getMonthlyIncludingTax(java.lang.String... args)
MemberType	getMtype(java.lang.String... args)
double	getQuarterlyIncludingTax(java.lang.String... args)
double	getRelativeAnnualRateIncTax(java.lang.String... args)
int	getYear(java.lang.String... args)
boolean	isAnnualDiscIncludesTax(java.lang.String... args)
boolean	isAnnualRateIncludesTax(java.lang.String... args)
boolean	isFlatRate(java.lang.String... args)
static DBQuery<MembershipRates>	makeQuery(DataSource ds) Make a new QUERY for this class.
static double	rateRound(double amount, int year) Rate round - 5.02 rounds to 5.00, 5.03 rounds to 5.05
MembershipRates	setAdjustFortnightlyIncludingTax(double value, java.lang.String... args)
MembershipRates	setAdjustHalfYearlyIncludingTax(double value, java.lang.String... args)
MembershipRates	setAdjustMonthlyIncludingTax(double value, java.lang.String... args)
MembershipRates	setAdjustQuarterlyIncludingTax(double value, java.lang.String... args)
MembershipRates	setAnnualDisc(double value, java.lang.String... args)
MembershipRates	setAnnualDiscIncludesTax(boolean value, java.lang.String... args)
MembershipRates	setAnnualRate(double value, java.lang.String... args)
MembershipRates	setAnnualRateIncludesTax(boolean value, java.lang.String... args)
MembershipRates	setClass(com.aspc.dal.layers.aspc_app.member.MemberClass value, java.lang.String... args)
MembershipRates	setDiscDay(int value, java.lang.String... args)
MembershipRates	setDiscMonth(int value, java.lang.String... args)
MembershipRates	setFlatRate(boolean value, java.lang.String... args)
MembershipRates	setID(int value, java.lang.String... args)
MembershipRates	setMtype(com.aspc.dal.layers.aspc_app.member.MemberType value, java.lang.String... args)
MembershipRates	setYear(int value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

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

Membership Rates

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Membership Rates

PARAM_TODAY

public static final java.lang.String PARAM_TODAY

for testing purpose only

See Also:

Constant Field Values

Constructor Detail

MembershipRates

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

Throws:

java.lang.Exception

getAdjustFortnightlyIncludingTax

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

setAdjustFortnightlyIncludingTax

@Nonnull
public MembershipRates setAdjustFortnightlyIncludingTax(double value,
                                                                 java.lang.String... args)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getAdjustHalfYearlyIncludingTax

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

setAdjustHalfYearlyIncludingTax

@Nonnull
public MembershipRates setAdjustHalfYearlyIncludingTax(double value,
                                                                java.lang.String... args)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

getAdjustMonthlyIncludingTax

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

setAdjustMonthlyIncludingTax

@Nonnull
public MembershipRates setAdjustMonthlyIncludingTax(double value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getAdjustQuarterlyIncludingTax

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

setAdjustQuarterlyIncludingTax

@Nonnull
public MembershipRates setAdjustQuarterlyIncludingTax(double value,
                                                               java.lang.String... args)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

isAnnualDiscIncludesTax

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

setAnnualDiscIncludesTax

@Nonnull
public MembershipRates setAnnualDiscIncludesTax(boolean value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getAnnualDiscIncludingTax

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

getAnnualDiscountRateToday

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

isAnnualRateIncludesTax

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

setAnnualRateIncludesTax

@Nonnull
public MembershipRates setAnnualRateIncludesTax(boolean value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getAnnualRateIncludingTax

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

getAnnualDisc

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

setAnnualDisc

@Nonnull
public MembershipRates setAnnualDisc(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getAnnualRate

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

setAnnualRate

@Nonnull
public MembershipRates setAnnualRate(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

setClass

@Nonnull
public MembershipRates setClass(com.aspc.dal.layers.aspc_app.member.MemberClass value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDiscDay

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

setDiscDay

@Nonnull
public MembershipRates setDiscDay(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDiscMonth

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

setDiscMonth

@Nonnull
public MembershipRates setDiscMonth(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isFlatRate

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

setFlatRate

@Nonnull
public MembershipRates setFlatRate(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getFortnightlyIncludingTax

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

getHalfYearlyIncludingTax

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

getMonthlyIncludingTax

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

getMtype

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

findMtype

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

Member type.

--> MemberType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MemberType

Throws:

NotFoundException - MemberType was not found

setMtype

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

Throws:

java.lang.Exception

getQuarterlyIncludingTax

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

getRelativeAnnualRateIncTax

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

getYear

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

setYear

@Nonnull
public MembershipRates setYear(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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

rateRound

public static double rateRound(double amount,
                               int year)

Rate round - 5.02 rounds to 5.00, 5.03 rounds to 5.05

Parameters:

amount -

Returns:

the value

getAnnualRelativeRate

public static double getAnnualRelativeRate(DBObject classification,
                                           DBObject memberType)
                                    throws java.lang.Exception

Throws:

java.lang.Exception