Package com.storedobject.core

Class Tax

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Tax

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class Tax
extends StoredObject

Represents a monetary tax amount computed for a given tax type and rate. When taxes are computed, for each calculation, the resulting tax amount is stored in this class.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Tax()	Default constructor for the Tax class.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures the columns for the provided Columns instance by adding specific column definitions.
String	getLabel()	Generates and returns a label that combines the name of the tax type with the tax rate.
Percentage	getRate()	Retrieves the rate as a percentage value.
TaxRegion	getRegion()	Retrieves the region information of the associated tax type.
Id	getRegionId()	Retrieves the Id of the tax region of the associated tax type.
Money	getTax()	Retrieves the tax amount associated with this entity.
TaxType	getType()	Retrieves the tax type associated with the current tax instance.
Id	getTypeId()	Retrieves the identifier representing the type.
void	setRate(Percentage rate)	Sets the rate for this instance.
void	setRate(Object value)	Sets the rate value by converting the provided object into a Percentage instance.
void	setTax(Money tax)	Sets the tax value for the current Tax object.
void	setTax(Object moneyValue)	Sets the tax value using the provided amount.
void	setType(Id typeId)	Sets the type for this Tax object using the specified type ID.
void	setType(TaxType type)	Sets the tax type by extracting and setting the ID from the provided TaxType object.
void	setType(BigDecimal idValue)	Sets the type of the tax entity using the given id value.
String	toString()	Returns a string representation of the Tax object, combining its label and tax value.
void	validate()	Validates the object to ensure it is in an acceptable state before operations such as saving to the database are performed.
void	validateData(TransactionManager tm)	Validates the tax data by ensuring all required fields, including the tax type, are properly set.

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, getUniqueCondition, 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, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, 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

Tax

public Tax()

Default constructor for the Tax class. Initializes a new instance of the Tax object with no specific parameters.

Method Details

columns

public static void columns(Columns columns)

Configures the columns for the provided Columns instance by adding specific column definitions.

Parameters:

columns - the Columns instance to which the columns should be added

setType

public void setType(Id typeId)

Sets the type for this Tax object using the specified type ID. Throws a Set_Not_Allowed exception if the type cannot be changed. Updates the tax rate based on the specified type ID.

Parameters:

typeId - The Id representing the type to set for this Tax object. If the type ID is null, the rate is not updated.

Throws:

Set_Not_Allowed - if the type is not allowed to be set in the current state.

setType

public void setType(BigDecimal idValue)

Sets the type of the tax entity using the given id value.

Parameters:

idValue - The BigDecimal value representing the identifier of the type to be set.

setType

public void setType(TaxType type)

Sets the tax type by extracting and setting the ID from the provided TaxType object.

Parameters:

type - The TaxType object whose ID is to be set. If the provided TaxType is null, a null value will be set.

getTypeId

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

Retrieves the identifier representing the type.

Returns:

The identifier of the type as an Id object.

getType

public TaxType getType()

Retrieves the tax type associated with the current tax instance.

Returns:

The tax type determined by the internal type identifier.

setRate

public void setRate(Percentage rate)

Sets the rate for this instance.

Parameters:

rate - The percentage rate to be set. It represents a value of type Percentage.

setRate

public void setRate(Object value)

Sets the rate value by converting the provided object into a Percentage instance.

Parameters:

value - The value to be converted to a Percentage and set as the rate.

getRate

@Column(order=200)
public Percentage getRate()

Retrieves the rate as a percentage value.

Returns:

The rate associated with this object, represented as a Percentage instance.

setTax

public void setTax(Money tax)

Sets the tax value for the current Tax object.

Parameters:

tax - the monetary amount representing the tax to be set

setTax

public void setTax(Object moneyValue)

Sets the tax value using the provided amount. The value is converted to a Money instance using the Money.create method before storing it.

Parameters:

moneyValue - The monetary value to set as tax. It can be any object convertible to Money.

getTax

@Column(order=200)
public Money getTax()

Retrieves the tax amount associated with this entity.

Returns:

the tax amount as a Money object

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the tax data by ensuring all required fields, including the tax type, are properly set. If the tax type is null, an exception is thrown with the description of the missing value. Additionally, invokes the superclass's validation logic.

Overrides:

validateData in class StoredObject

Parameters:

tm - The TransactionManager instance to manage this validation process.

Throws:

Invalid_Value - If the tax type is not set.

Exception - If the superclass validation or other validation logic encounters an issue.

validate

public void validate()
              throws Exception

Validates the object to ensure it is in an acceptable state before operations such as saving to the database are performed. This method is overridden to enforce specific internal validation logic. It performs the following checks: 1. Verifies whether the object is marked as internal. If it is not internal, an Invalid_State exception is thrown with an error message indicating illegal access. 2. Invokes the superclass's `validate` method to ensure further state or business logic validation is executed. Note: Failing to call the superclass's `validate` method may result in a design error.

Overrides:

validate in class StoredObject

Throws:

Invalid_State - if the object is accessed illegally when not marked as internal.

Exception - if any other conditions in the superclass validation fail.

toString

public String toString()

Returns a string representation of the Tax object, combining its label and tax value.

Overrides:

toString in class StoredObject

Returns:

A string composed of the label and the tax value, separated by a space.

getLabel

public String getLabel()

Generates and returns a label that combines the name of the tax type with the tax rate.

Returns:

A string representing the label in the format " @".

getRegion

public TaxRegion getRegion()

Retrieves the region information of the associated tax type.

Returns:

The TaxRegion corresponding to the tax type of this tax.

getRegionId

public Id getRegionId()

Retrieves the Id of the tax region of the associated tax type.

Returns:

The Id corresponding to the tax region of this tax.