com.aspc.Layers.aspc_app.Accounts

Class Account

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Accounts.Account

All Implemented Interfaces:

SecondaryCacheGroup

public class Account
extends DBObject

An Account is a category that you want to use to organise the financial affairs of your business.

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

Since:

December 22, 2003, 9:41 AM

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 An Account is a category that you want to use to organise the financial affairs of your business.
static java.lang.String	DBCLASS_NAME An Account is a category that you want to use to organise the financial affairs of your business.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Account	create(MutableDataSource mds) Make a new instance of this class.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
BankAccount	findBankAccount(java.lang.String... args) Linked to the Bank Account object if this account is a Detail Bank account.
AccountClassification	findClassification(java.lang.String... args) The classification of the account such as Asset or Liability.
static Account	findKey(DataSource ds, int key) Find the target for this class by the primary key
AccountType	findType(java.lang.String... args) Identifies the account type such as a Header, Detail or Bank.
BankAccount	getBankAccount(java.lang.String... args)
AccountClassification	getClassification(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
static Account	getDefaultExpenseAccount(DataSource ds)
static Account	getDefaultIncomeAccount(DataSource ds)
java.lang.String	getFormatedCode(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
int	getNumber(java.lang.String... args)
static Account	getReceivablesAssetAccount(DataSource ds)
static Account	getReceivablesBankAccount(DataSource ds)
AccountType	getType(java.lang.String... args)
boolean	isInactive(java.lang.String... args)
static DBQuery<Account>	makeQuery(DataSource ds) Make a new QUERY for this class.
Account	setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount value, java.lang.String... args)
Account	setClassification(com.aspc.dal.layers.aspc_app.accounts.AccountClassification value, java.lang.String... args)
Account	setID(int value, java.lang.String... args)
Account	setInactive(boolean value, java.lang.String... args)
Account	setName(java.lang.String value, java.lang.String... args)
Account	setNumber(int value, java.lang.String... args)
Account	setType(com.aspc.dal.layers.aspc_app.accounts.AccountType 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, 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

An Account is a category that you want to use to organise the financial affairs of your business.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

An Account is a category that you want to use to organise the financial affairs of your business.

Constructor Detail

Account

public Account(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 Account setID(int 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

Linked to the Bank Account object if this account is a Detail Bank account.

--> BankAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

BankAccount

Throws:

NotFoundException - BankAccount was not found

setBankAccount

@Nonnull
public Account setBankAccount(com.aspc.dal.layers.aspc_app.misc.BankAccount value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getClassification

@CheckReturnValue
 @Nullable
public AccountClassification getClassification(java.lang.String... args)

findClassification

@CheckReturnValue
 @Nonnull
public final AccountClassification findClassification(java.lang.String... args)
                                                                           throws NotFoundException

The classification of the account such as Asset or Liability.

--> AccountClassification (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

AccountClassification

Throws:

NotFoundException - AccountClassification was not found

setClassification

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

Throws:

java.lang.Exception

getCode

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

getFormatedCode

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

isInactive

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

setInactive

@Nonnull
public Account setInactive(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public Account setName(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getNumber

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

setNumber

@Nonnull
public Account setNumber(int value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public AccountType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final AccountType findType(java.lang.String... args)
                                                       throws NotFoundException

Identifies the account type such as a Header, Detail or Bank.

--> AccountType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

AccountType

Throws:

NotFoundException - AccountType was not found

setType

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

Throws:

java.lang.Exception

create

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

getDefaultIncomeAccount

public static Account getDefaultIncomeAccount(DataSource ds)

Parameters:

ds - the data source

Returns:

the value

getDefaultExpenseAccount

public static Account getDefaultExpenseAccount(DataSource ds)

Parameters:

ds - the data source

Returns:

the value

getReceivablesAssetAccount

public static Account getReceivablesAssetAccount(DataSource ds)

Parameters:

ds - the data source

Returns:

the value

getReceivablesBankAccount

public static Account getReceivablesBankAccount(DataSource ds)

Parameters:

ds - the data source

Returns:

the value

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

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem