Package com.storedobject.accounts

Class AccountConfiguration

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.accounts.AccountConfiguration

All Implemented Interfaces:

Displayable, StringFiller, HasId, OfEntity

public final class AccountConfiguration
extends StoredObject
implements OfEntity

This class is used to configure accounts for posting transactions such as purchase and sales invoices.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
AccountConfiguration()	This class represents an Account Configuration.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Adds columns to the given Columns object.
Account	getAccount()	Retrieves the Account related to the current AccountConfiguration.
Id	getAccountId()	Returns the account Id.
int	getAllow()
static String[]	getAllowBitValues()
String	getAllowValue()
static String	getAllowValue(int value)
int	getCategory()	Returns the category of the item.
String	getCategoryValue()	Returns the category value.
static String	getCategoryValue(int value)	Returns the category value corresponding to the given input value.
static String[]	getCategoryValues()	Retrieves the list of category values.
Class<? extends EntityAccount>	getEntityAccountClass()
String	getEntityAccountClassName()	Retrieves the entity account class name.
static AccountConfiguration	getFor(Id systemEntityId, int category, int type)	Retrieves the AccountConfiguration for a given SystemEntity, category, and type.
String	getName()	Retrieves the name of the AccountConfiguration.
SystemEntity	getSystemEntity()	Retrieves the system entity associated with this AccountConfiguration.
Id	getSystemEntityId()	Retrieves the system entity ID.
int	getType()	Returns the type of the object.
String	getUniqueCondition()	Retrieves the unique condition used for querying the system.
static int	hints()	Provides hints about objects.
static void	indices(Indices indices)	Adds indices to the given Indices object.
void	saved()	This method is invoked whenever an instance is saved/deleted/resurrected.
void	setAccount(Account account)	Sets the account for this AccountConfiguration.
void	setAccount(Id accountId)	Sets the account ID for the current object.
void	setAccount(BigDecimal idValue)	Sets the account for this object using the specified id value.
void	setAllow(int allow)
void	setCategory(int category)	Sets the category for the object.
void	setEntityAccountClassName(String entityAccountClassName)	Sets the entity account class name.
void	setName(String name)	Sets the name for this object.
void	setSystemEntity(Id systemEntityId)	Sets the system entity Id for this object.
void	setSystemEntity(SystemEntity systemEntity)	Sets the system entity for this AccountConfiguration.
void	setSystemEntity(BigDecimal idValue)	Sets the system entity using the provided id value.
void	setType(int type)	Sets the type of the object.
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

AccountConfiguration

public AccountConfiguration()

This class represents an Account Configuration. It provides a constructor to create an instance of AccountConfiguration.

Method Details

columns

public static void columns(Columns columns)

Adds columns to the given Columns object.

Parameters:

columns - The Columns object to add the columns to.

indices

public static void indices(Indices indices)

Adds indices to the given Indices object.

Parameters:

indices - the Indices object to add indices to

getUniqueCondition

public String getUniqueCondition()

Retrieves the unique condition used for querying the system. The condition is formed by concatenating the system entity ID, category, and type.

Overrides:

getUniqueCondition in class StoredObject

Returns:

The unique condition.

hints

public static int hints()

Provides hints about objects.

This method returns a combination of hints representing certain characteristics of objects. The possible hints are defined in the ObjectHint class.

Returns:

An integer value that represents a combination of hints. The hints can be extracted using binary AND operations.

See Also:

• ObjectHint

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Sets the system entity Id for this object.

Specified by:

setSystemEntity in interface OfEntity

Parameters:

systemEntityId - the Id of the system entity to set

Throws:

Set_Not_Allowed - if the method is called when the object is not in a loading state or if the provided system entity Id is different from the current one

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

Sets the system entity using the provided id value.

Parameters:

idValue - the id value of the system entity

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

Sets the system entity for this AccountConfiguration.

Parameters:

systemEntity - The system entity to set. If null, the system entity will be set to null.

getSystemEntityId

@SetNotAllowed
@Column(order=100)
public Id getSystemEntityId()

Retrieves the system entity ID.

Specified by:

getSystemEntityId in interface OfEntity

Returns:

the system entity ID

getSystemEntity

public SystemEntity getSystemEntity()

Retrieves the system entity associated with this AccountConfiguration.

Specified by:

getSystemEntity in interface OfEntity

Returns:

The SystemEntity object associated with this AccountConfiguration.

setName

public void setName(String name)

Sets the name for this object.

Parameters:

name - The name to set.

getName

@Column(order=150)
public String getName()

Retrieves the name of the AccountConfiguration.

Returns:

The name of the AccountConfiguration as a string.

setCategory

public void setCategory(int category)

Sets the category for the object.

Parameters:

category - the new category to be set

Throws:

Set_Not_Allowed - if setting the category is not allowed

getCategory

@SetNotAllowed
@Column(order=200)
public int getCategory()

Returns the category of the item.

Returns:

the category of the item as an integer.

getCategoryValues

public static String[] getCategoryValues()

Retrieves the list of category values.

Returns:

an array of strings representing the category values.

getCategoryValue

public static String getCategoryValue(int value)

Returns the category value corresponding to the given input value.

Parameters:

value - the input value for which the category value is required

Returns:

the category value corresponding to the given input value

getCategoryValue

public String getCategoryValue()

Returns the category value.

Returns:

the category value as a string.

setType

public void setType(int type)

Sets the type of the object.

Parameters:

type - the new type to be set

Throws:

Set_Not_Allowed - if loading() is false, indicating that setting the type is not allowed

getType

@SetNotAllowed
@Column(required=false,
        order=300)
public int getType()

Returns the type of the object.

Returns:

the type of the object.

setAccount

public void setAccount(Id accountId)

Sets the account ID for the current object.

Parameters:

accountId - the unique identifier of the account

setAccount

public void setAccount(BigDecimal idValue)

Sets the account for this object using the specified id value.

Parameters:

idValue - the value for the account id

setAccount

public void setAccount(Account account)

Sets the account for this AccountConfiguration.

Parameters:

account - The account to set. If null, the account ID will be set to null.

getAccountId

@Column(style="(any)",
        order=400,
        caption="Purchase/Sale Account")
public Id getAccountId()

Returns the account Id.

Returns:

the account Id

getAccount

public Account getAccount()

Retrieves the Account related to the current AccountConfiguration.

Returns:

The related Account object.

setEntityAccountClassName

public void setEntityAccountClassName(String entityAccountClassName)

Sets the entity account class name.

Parameters:

entityAccountClassName - the fully qualified class name

getEntityAccountClassName

@Column(order=500)
public String getEntityAccountClassName()

Retrieves the entity account class name.

Returns:

the entity account class name.

setAllow

public void setAllow(int allow)

getAllow

@Column(order=600,
        required=false)
public int getAllow()

getAllowBitValues

public static String[] getAllowBitValues()

getAllowValue

public static String getAllowValue(int value)

getAllowValue

public String getAllowValue()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

saved

public void saved()
           throws Exception

Description copied from class: StoredObject

This method is invoked whenever an instance is saved/deleted/resurrected. It can be overridden to take care of any additional actions required by the application.

Overrides:

saved in class StoredObject

Throws:

Exception - When error occurs or invalidate state exists so that transaction will be abandoned.

getEntityAccountClass

public Class<? extends EntityAccount> getEntityAccountClass()

getFor

public static AccountConfiguration getFor(Id systemEntityId,
 int category,
 int type)

Retrieves the AccountConfiguration for a given SystemEntity, category, and type.

Parameters:

systemEntityId - The Id of the System Entity.

category - The category of the AccountConfiguration.

type - The type of the AccountConfiguration.

Returns:

The AccountConfiguration object corresponding to the provided SystemEntity, category, and type.

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.