Package com.storedobject.core

Class TaxMethod

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Name

com.storedobject.core.TaxMethod

All Implemented Interfaces:

Displayable, HasName, StringFiller, HasId

Direct Known Subclasses:

FixedTax, NoTax

public class TaxMethod
extends Name

Represents a taxation method for financial calculations. Provides functionality to calculate taxes based on specific logic, manage active state, and implement data validation. Caching is implemented to optimize retrieval by maintaining a static map of cached TaxMethod objects.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.Name

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
TaxMethod()	Constructs a TaxMethod object with a default tax calculation method name.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures columns for a data model by adding a column named "Active" with a type of "boolean".
boolean	getActive()	Retrieves the active status of the tax method.
static TaxMethod	getFor(Id id)	Retrieves a TaxMethod instance for the provided Id.
Money	getTax(InventoryItemType itemType, Quantity quantity, Money unitCost, Percentage taxRate, Currency localCurrency)	Calculates the tax amount for a given inventory item based on its type, quantity, unit cost, tax rate, and local currency.
static int	hints()	Provides hints for this object, indicating specific characteristics or optimizations associated with the object or its usage.
static void	indices(Indices indices)	Modifies the given indices object by adding a specific index with a specified condition.
Money	round(Money taxAmount)	Rounds the given monetary amount to the nearest valid value based on the specific rounding rules defined.
void	saved()	Removes the cached entry associated with this instance's Id after the object is saved.
void	setActive(boolean active)	Sets the active status of the object.
void	validateData(TransactionManager tm)	Validates the data associated with a TaxMethod instance.

Methods inherited from class com.storedobject.core.Name

getName, getUniqueCondition, setName, toString

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, migrateLink, migrateLink, 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, 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

Constructor Details

TaxMethod

public TaxMethod()

Constructs a TaxMethod object with a default tax calculation method name. The default name is set to "Percentage".

Method Details

columns

public static void columns(Columns columns)

Configures columns for a data model by adding a column named "Active" with a type of "boolean".

Parameters:

columns - The columns object to which the "Active" column is added. Represents a set of definable columns in a database or data structure.

indices

public static void indices(Indices indices)

Modifies the given indices object by adding a specific index with a specified condition.

Parameters:

indices - The object representing the collection of indices to be modified.

hints

public static int hints()

Provides hints for this object, indicating specific characteristics or optimizations associated with the object or its usage.

Returns:

A bitwise combination of constants from the ObjectHint class, such as ObjectHint.SMALL and ObjectHint.SMALL_LIST, representing the applicable hints.

setActive

public void setActive(boolean active)

Sets the active status of the object.

Parameters:

active - a boolean value indicating whether the object should be active (true) or inactive (false)

getActive

@Column(order=300)
public boolean getActive()

Retrieves the active status of the tax method.

Returns:

true if the tax method is active, false otherwise.

saved

public void saved()
           throws Exception

Removes the cached entry associated with this instance's Id after the object is saved. This method is invoked when the object state is persisted, ensuring the cache remains consistent with the underlying state.

Overrides:

saved in class StoredObject

Throws:

Exception - if an error occurs during the cache removal process.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the data associated with a TaxMethod instance. This method ensures that the correct TaxMethod types exist and checks for possible duplicate entries, throwing exceptions in case of invalid or inconsistent states.

Overrides:

validateData in class Name

Parameters:

tm - The transaction manager used to handle database transactions during validation.

Throws:

Exception - Thrown if validation encounters an invalid state, such as duplicate entries or missing required TaxMethod types.

getFor

public static TaxMethod getFor(Id id)

Retrieves a TaxMethod instance for the provided Id. If the instance is not found in the cache, it fetches the instance, caches it, and then returns it.

Parameters:

id - the unique identifier of the TaxMethod to retrieve

Returns:

the TaxMethod instance associated with the provided Id, or null if not found

getTax

public Money getTax(InventoryItemType itemType,
 Quantity quantity,
 Money unitCost,
 Percentage taxRate,
 Currency localCurrency)

Calculates the tax amount for a given inventory item based on its type, quantity, unit cost, tax rate, and local currency.

Parameters:

itemType - the type of the inventory item for which the tax is being calculated

quantity - the quantity of the inventory item

unitCost - the cost per unit of the inventory item

taxRate - the percentage tax rate to be applied

localCurrency - the currency in which the tax amount should be calculated

Returns:

the calculated tax amount in the specified local currency

round

public Money round(Money taxAmount)

Rounds the given monetary amount to the nearest valid value based on the specific rounding rules defined.

Parameters:

taxAmount - the monetary amount to be rounded

Returns:

the rounded monetary amount