Package com.storedobject.accounts

Class TaxAccountConfiguration

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.accounts.TaxAccountConfiguration

All Implemented Interfaces:

Displayable, StringFiller, HasId, OfEntity

public final class TaxAccountConfiguration
extends StoredObject
implements OfEntity

This class is used to configure tax accounts.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
TaxAccountConfiguration()	This class represents a Tax 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.
SystemEntity	getSystemEntity()	Retrieves the system entity associated with this AccountConfiguration.
Id	getSystemEntityId()	Retrieves the system entity ID.
TaxType	getType()	Returns the TaxType associated with the current instance.
Id	getTypeId()	Retrieves the type ID of the tax type.
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	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	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(Id typeId)	Sets the type of tax.
void	setType(TaxType type)	Sets the type of tax.
void	setType(BigDecimal idValue)	Sets the type of tax.
void	validateData(TransactionManager tm)	The system will invoke this 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, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, 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, listDeletedIds, 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, loadAttributesFrom, 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, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, 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

TaxAccountConfiguration

public TaxAccountConfiguration()

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

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 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.

setType

public void setType(Id typeId)

Sets the type of tax.

Parameters:

typeId - the Id representing the desired type

Throws:

Set_Not_Allowed - if the method is called outside the loading state and the new typeId is different from the current typeId

setType

public void setType(BigDecimal idValue)

Sets the type of tax.

Parameters:

idValue - the BigDecimal value of the id to set as the new type

setType

public void setType(TaxType type)

Sets the type of tax.

Parameters:

type - the TaxType to set.

getTypeId

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

Retrieves the type ID of the tax type.

Returns:

the type ID of the tax type

getType

public TaxType getType()

Returns the TaxType associated with the current instance.

Returns:

the TaxType object for the current instance.

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)
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.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting 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.