com.aspc.Layers.aspc_app.bsb

Class Bsb

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.bsb.Bsb

All Implemented Interfaces:

SecondaryCacheGroup

public class Bsb
extends DBObject

Bsb.java Bsb- bank-branch.

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

Since:

$Date: 2014-12-19 04:52:47 $

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 Bsb- bank-branch
static java.lang.String	DBCLASS_NAME Bsb- bank-branch

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Bsb	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.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
java.lang.Object	findBankId(java.lang.String... args) the bank id.
static Bsb	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
Suburb	findSuburb(java.lang.String... args) Bsb suburb.
static java.lang.String	genBsbNumber(int bankId, int branchID) generate Bsb number - 6 digit number
java.lang.String	getAddress(java.lang.String... args)
java.lang.Object	getBankId(java.lang.String... args)
int	getBranchId(java.lang.String... args)
java.lang.String	getBranchName(java.lang.String... args)
java.lang.String	getBsbNumber(java.lang.String... args)
java.lang.String	getDisplayBsbNumber(java.lang.String... args)
java.lang.String	getFax(java.lang.String... args)
java.lang.String	getPhone(java.lang.String... args)
Suburb	getSuburb(java.lang.String... args)
boolean	isCuFlag(java.lang.String... args)
static DBQuery<Bsb>	makeQuery(DataSource ds) Make a new QUERY for this class.
Bsb	setAddress(java.lang.String value, java.lang.String... args)
Bsb	setBankId(java.lang.Object value, java.lang.String... args)
Bsb	setBranchId(int value, java.lang.String... args)
Bsb	setBranchName(java.lang.String value, java.lang.String... args)
Bsb	setBsbNumber(java.lang.String value, java.lang.String... args)
Bsb	setCuFlag(boolean value, java.lang.String... args)
Bsb	setFax(java.lang.String value, java.lang.String... args)
Bsb	setPhone(java.lang.String value, java.lang.String... args)
Bsb	setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb 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, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Bsb- bank-branch

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Bsb- bank-branch

Constructor Detail

Bsb

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

getBsbNumber

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

setBsbNumber

@Nonnull
public Bsb setBsbNumber(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getAddress

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

setAddress

@Nonnull
public Bsb setAddress(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getBankId

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

findBankId

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

the bank id.

--> Bank (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Bank

Throws:

NotFoundException - Bank was not found

setBankId

@Nonnull
public Bsb setBankId(java.lang.Object value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getBranchId

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

setBranchId

@Nonnull
public Bsb setBranchId(int value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getBranchName

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

setBranchName

@Nonnull
public Bsb setBranchName(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

isCuFlag

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

setCuFlag

@Nonnull
public Bsb setCuFlag(boolean value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayBsbNumber

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

getFax

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

setFax

@Nonnull
public Bsb setFax(java.lang.String value,
                           java.lang.String... args)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getPhone

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

setPhone

@Nonnull
public Bsb setPhone(java.lang.String value,
                             java.lang.String... args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getSuburb

@CheckReturnValue
 @Nullable
public Suburb getSuburb(java.lang.String... args)

findSuburb

@CheckReturnValue
 @Nonnull
public final Suburb findSuburb(java.lang.String... args)
                                                    throws NotFoundException

Bsb suburb.

--> Suburb (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Suburb

Throws:

NotFoundException - Suburb was not found

setSuburb

@Nonnull
public Bsb setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Bsb 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<Bsb> 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 Bsb findKey(@Nonnull
                                                      DataSource ds,
                                                      @Nonnull
                                                      java.lang.String 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

extValidateField

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

Description copied from class: DBObject

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 overriding 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:

field - The field

list -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

genBsbNumber

public static java.lang.String genBsbNumber(int bankId,
                                            int branchID)

generate Bsb number - 6 digit number

Parameters:

bankId - bankId

branchID - branchid

Returns:

the value

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

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